Get Auth Module

Request


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

Parameter	Description
`fields`	Optional query parameter. Specifies a subset of the fields to be returned. Use Fields Syntax to define subset.

Response

Response Code	Meaning
200 OK	Successful request.
400 Bad Request	Some of the parameters of the request are invalid (for example, required fields in the passed JSON object are missing). The response contains message describing the error.
403 Forbidden	Requester has no access to the request.
404 Not Found	Requested resource wasn't found.
500 Internal Server Error	Failed to process request because of the server error. The response contains message describing the error.

Response body

authmodule

extended by 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: 20 November 2017