Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Administering user profiles

Add a new user.

Adds a new user and returns the user object.<br />User roles: admin

post/user-profile/v1/users

Request body

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

uidstring

Acoustic Id of the user, if not present during POST call an Acoustic Id will be created for 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

Response

User was created successfully.

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

uidstring

Acoustic Id of the user, if not present during POST call an Acoustic Id will be created for 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