Get Auth Module
Request
GET [[[<REST API URL>|Hub-Rest-Api-URL.html]]]/authmodules/auth module id?fields=string
Parameter | Description |
---|---|
| 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|HUB-REST-API_JSON-Scheme.html#alias]]], ...],
"name": string,
"ordinal": int,
"accountsSize": int,
"disabled": boolean,
"isDefault": boolean,
"autoJoinGroups": [[[[userGroup|HUB-REST-API_JSON-Scheme.html#userGroup]]], ...]
}
14 October 2024