Authentication Groups
You can use REST API calls to obtain
information about existing authentication groups.
The following table lists the properties that can be used in the body of an authentication groups-related request and/or are provided in the response body. (In the "Optional" column, if a default value is applicable, it is listed in angle brackets (< >).
Resource: Group
| Property Name | Type | Editable | Sort/Filter | Optional in Request/Response Body? | Description |
|---|---|---|---|---|---|
| guid | String | No | Neither | No | The unique identifier for this authentication group. |
| name | String | No | orderBy, like | No | The unique reference name of the authentication group. |
| cn | String | No | orderBy, like | Yes | The common name for this authentication group. Not all authentication servers support this as "CN"; refer to your authentication-server documentation for information about mapping server type into authentication groups. |
| dn | String | No | orderBy, like | Yes | The distinguished name for this authentication group. Not all authentication servers support this as "DN"; refer to your authentication-server documentation for information about mapping server type into authentication groups. |
| type | String | No | orderBy, like | Yes | The type of authentication group. Not all authentication servers support a group type. Refer to your authentication-server documentation for information about mapping server type into authentication groups. |
| links[] | Link array | No | No | No | Self-referencing link, parent (authenticationServers) |
Group URIs and Actions
The following table indicates the URIs that you can append to the root URI, along with the actions you can take, and possible return codes you can receive.