Get Auth Module

Last modified: 11 March 2025

Request

GET <REST API URL>/authmodules/{auth module id}?fields=string

Parameter	Description
`fields`	Optional. Returns only the specified subset of the fields for each AuthModule. Use Fields Syntax to define the subset.

Response

Response Code	Meaning
200 OK	Successful request.
400 Bad Request	At least one of the request parameters is invalid. For example, a required field in the passed JSON object is missing. For details, check the error message in the response.
403 Forbidden	The requester has no access to the requested resource.
404 Not Found	The requested resource was not found.
500 Internal Server Error	Failed to process request because of the server error. For details, check the error message in the response.

Response body


  {
    "id": string, 
    "aliases": [alias, ...], 
    "name": string, 
    "ordinal": int, 
    "accountsSize": int, 
    "disabled": boolean, 
    "isDefault": boolean, 
    "autoJoinGroups": [userGroup, ...]
  }

Get Auth Module﻿

Request﻿

Response﻿

Response body﻿

Get Auth Module

Request

Response

Response body