Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Administering user profiles

Find user by ID.

Returns a single user.<br />User roles: admin

get/user-profile/v1/users/{id}

Path parameters

idstring required

The unique internal identifier of the entity that should be processed or the special value currentuser that uses the ID provided in the userID header.

Query parameters

privacy-noticestring

Parameter which must be set if the users privacy notice should be returned

Headers

x-ibm-dx-user-authstring

JWT encrypted user context set by login process

Response

Returns the user object for the given user.

idstring required

The unique internal identifier of the user

externalIdstring required

The unique external identifier of the user (e.g. BlueID). Although, this field can store email addresses, other types of unique identifiers may be stored too. Do not use this field as a replacement for the user attribute email address.

firstNamestring

The first name of the user

lastNamestring

The last name of the user

displayNamestring

The name of the user that can be displayed in the UI

emailstring email

The email of the user that can be displayed in the UI

rolesstring[] required

The roles of the user that will be used for access control (empty for the anonymous user)

lastLoginstring date-time

Date when this user logged in for the last time before current session

createdstring date-time

Date when this item was created

lastModifiedstring date-time

Date when this item was modified for the last time