Authentication Server Users

You can use REST API calls to obtain information about Cloudpath users in an authentication server as well as to update information about specific users.

The following table lists the properties that can be used in the body of a user-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: Users

Property Name Type Editable Sort/Filter Optional in Request/Response Body? Description
guid String No Neither No* The unique identifier for this user.
name String No orderBy, like No The unique reference name for this user.
status enum <String> Yes orderBy, eq No

The status of this user. Can be: ACTIVE, BLOCKED, REVOKE_ENROLLMENTS

BLOCKED prevents a user from authenticating, and blocks all existing enrollments.

REVOKE_ENROLLMENTS revokes all existing enrollments for this user. However, the status of the user does not change; therefore, if this user is active, the user could create a new enrollment.

blockReason String Yes None Yes Will be set if the user's status is changes to BLOCKED or REVOKE_ENROLLMENTS.
firstName String No orderBy, like No Provided by the authentication server during the authentication process.
lastName String No orderBy, like No Provided by the authentication server during the authentication process.
email String No orderBy, like No Provided by the authentication server during the authentication process.
commonName String No orderBy, like No Provided by the authentication server during the authentication process.
distinguishedName String No orderBy, like No Provided by the authentication server during the authentication process.
officeName String No orderBy, like No Provided by the authentication server during the authentication process.
company String No orderBy, like No Provided by the authentication server during the authentication process.
department String No orderBy, like No Provided by the authentication server during the authentication process.
ou String No orderBy, like No Provided by the authentication server during the authentication process.
city String No orderBy, like No Provided by the authentication server during the authentication process.
state String No orderBy, like No Provided by the authentication server during the authentication process.
country String No orderBy, like No Provided by the authentication server during the authentication process.
oauthType Enum <String> No orderBy, like No Indicates the type of authentication that this user followed: ACTIVE_DIRECTORY, LDAP, FACEBOOK, LINKEDIN, GOOGLE, SAML, or CUSTOM
lastPeapAuthDate DateTime No orderBy, Yes The most recent date that this user authenticated through PEAP.
lastAssignedPolicy String No

orderBy, like

 No The name of the policy most recently applied to this user.
automaticVlan Long No orderBy, No The automatic vlan assigned to the user if enabled on the authentication server.
links[] Link array Yes* No No Self-referencing link, enrollments, parent (authenticationServer), groups

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

Users URIs and Actions

URI Action Description Return Codes
/authenticationServers/{authSvrId}/users GET Returns the list of Cloudpath users on this authentication server.

404 - Not found

401 - Unauthorized

200 - Ok
/authenticationServers/{authSvrId}/users/{id} GET Returns details about the specified Cloudpath user on the authentication server.

404 - Not found

401 - Unauthorized

200 - Ok
PUT Updates the specified Cloudpath user on the authentication server.

409 - Conflict

404 - Not found

401 - Unauthorized

200 - Ok
/authenticationServers/{authSvrId}/users/{id}/groups GET Returns the list of authentication groups that the specified authentication-server user belongs to within the specified authentication server.
Shannon - Is this correct? FYI this entry is blank in the wiki

404 - Not found

401 - Unauthorized

200 - Ok
Parent topic: Authentication Servers and Related Resources