Hub 2018.1 Help

Get Auth Module


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 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


extended by clientCertificateAuthModule, coreauthmodule, externalauthmodule, externaloauth2module, externalpasswordauthmodule, githubauthmodule, googleauthmodule, jbaauthmodule, jiraauthmodule, ldapauthmodule, oauth2authmodule, openidauthmodule, userCreationAuthModule

{ "id": string, "aliasIds": [string, ...], "aliases": [alias, ...], "name": string, "ordinal": int, "accountsSize": int, "disabled": boolean, "autoJoinGroups": [userGroup, ...] }
Last modified: 22 May 2018