Users

Get user

Returns a provisioned user by their unique identifier. The identifier in this case is the internal Peakon ID of the user returned in the response of the Create user operation. If you wish to retrieve the user by externalId instead, consider using the Get all users operation and filter by externalId, which would have been provided when the user was first created/provisioned.

get/Users/{id}

Request

  • Base URL
    https://api.peakon.com/api/scim/v2
  • URL
    https://api.peakon.com/api/scim/v2/Users/{id}
  • Auth
    none declared

Path parameters

idstring required

user id

Response

successful operation

activeboolean

user status

externalIdstring

external unique resource id defined by provisioning client

idstring

unique resource id

schemasstring[] required
userNamestring required

MUST be same as work type email address

Changes

No recorded changes to this operation across all 1 revision of this API.