Users

Get a user by name

Get a user by name.

get/v1/users/name/{name}

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/users/name/{name}
  • Auth: HTTP bearer

Path parameters

namestring required

Name of the user

Query parameters

fieldsstring
Example:profile,roles,teams,follows,owns,domains,personas,defaultPersona,personaPreferences

Fields requested in the returned resource

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

The user

idstring uuid required
namestring required
fullyQualifiedNamestring
descriptionstring
externalIdstring
scimUserNamestring
displayNamestring
versionnumber double
updatedAtinteger
updatedBystring
impersonatedBystring
emailstring required
hrefstring uri
timezonestring
isBotboolean
isAdminboolean
allowImpersonationboolean
deletedboolean
isEmailVerifiedboolean
lastLoginTimeinteger
lastActivityTimeinteger
provider'system' | 'user' | 'automation'
extensionobject
entityStatus'Draft' | 'In Review' | 'Approved' | 'Archived' | 'Deprecated' | 'Rejected' | 'Unprocessed'
sourceHashstring

Changes

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