Get a user by ID

GET /api/2.0/portal/users/{userID}

Request

Returns a user with the ID specified in the request from the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Path

userIDstringformat: uuidrequired

User ID

Examples

GET /api/2.0/portal/users/603fac16-9750-498f-b82e-3aedc7f7af84 HTTP/1.1
Accept: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/portal/users/603fac16-9750-498f-b82e-3aedc7f7af84 \
  --header 'Accept: application/json'

Responses

200

User information

idstringformat: uuid

firstNamestring

lastNamestring

userNamestring

birthDatestringformat: date-time

sexboolean

statusone of

.enum of string

[Active - Active, Terminated - Terminated, Pending - Pending, Default - Default, All - All]

Can be one of: Active, Terminated, Pending, Default, All.

.enum of integer

[1 - Active, 2 - Terminated, 4 - Pending, 5 - Default, 7 - All]

Can be one of: 1, 2, 4, 5, 7.

activationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated, Pending - Pending, AutoGenerated - Auto generated]

Can be one of: NotActivated, Activated, Pending, AutoGenerated.

.enum of integer

[0 - Not activated, 1 - Activated, 2 - Pending, 4 - Auto generated]

Can be one of: 0, 1, 2, 4.

terminatedDatestringformat: date-time

titlestring

workFromDatestringformat: date-time

emailstringformat: email

contactsstring

contactsListarray of unknown

locationstring

notesstring

removedboolean

lastModifiedstringformat: date-time

tenantIdintegerformat: int32

isActiveboolean

cultureNamestring

mobilePhonestring

mobilePhoneActivationStatusone of

.enum of string

[NotActivated - Not activated, Activated - Activated]

Can be one of: NotActivated, Activated.

.enum of integer

[0 - Not activated, 1 - Activated]

Can be one of: 0, 1.

sidstring

ldapQoutaintegerformat: int64

ssoNameIdstring

ssoSessionIdstring

createDatestringformat: date-time

checkActivationboolean

401

Unauthorized

403

Forbidden