Article summary
Did you find this summary helpful?
Thank you for your feedback
POST /v1/users
Create a new user.
Parameters: None
Request Body: CreateUserDto
Request Example:
curl -X POST -H 'Authorization: Bearer <ACCESS_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"idpType": "database",
"accessGroups": [
"string",
"string"
],
"email": "string",
"emailVerified": true,
"inviteMessage": "string",
"profileData": {
"firstName": "string",
"lastName": "string",
"roleName": "string",
"phone": "string"
},
"origin": "API"
}' 'https://api.perimeter81.com/api/rest/v1/users'
Response Body:
Message/Response Body | Description | |
---|---|---|
201 | Success. The resource was created. | |
400 | Bad request. | |
401 | Unauthorized | Wrong or expired Access Token |
Response Example (201):
{
"tenantId":<TENANT_ID>,
"terminated":false,
"initialsColor":"#E46086",
"invitationAttempts":0,
"invitationToken":"<INVITATION_TOKEN>",
"role":"NaHaEa8ayL",
"username":"<USER_EMAIL>",
"email":"<USER_EMAIL>",
"emailVerified":true,
"inviteMessage":"<INVITE_TEXT>",
"roleName":"<PROFILE_ROLE>",
"firstName":"<FIRST_NAME>",
"lastName":"<LAST_NAME>",
"phone":"<PHONE>",
"initials":"DT",
"idProviders":{
"database":{
"userId":null
}
},
"createdAt":"2021-09-29T13:59:56.694Z",
"updatedAt":"2021-09-29T13:59:56.694Z",
"id":"eZHoeJR2Y5"
}
Was this article helpful?