Tenant User Management

Tenant User Managemen operations

Invite a User to Tenant

Role Requirements

tenant-admin

Description

Invites a User to the Tenant.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Request Body schema:
emailAddress
string or null
roles
Array of strings or null
Responses
201

Created - Returns the Create Invitation response.

401

Unauthorized

403

Forbidden

post/v1/tenant/invitation/invite
Request samples
{
  • "emailAddress": "string",
  • "roles": [
    • "string"
    ]
}
Response samples
application/json
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "emailAddress": "string",
  • "expiryDate": "2019-08-24T14:15:22Z",
  • "invitationStatus": "string",
  • "roles": [
    • "string"
    ]
}

Resend Invitation to Tenant User

Role Requirements

tenant-admin

Description

Resends the Tenant User invitation.

Securitybearer
Request
header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Request Body schema:
userId
string <uuid>

The Id of the User to receive the replacement Invitation.

Responses
201

Created.

401

Unauthorized

403

Forbidden

post/v1/tenant/invitation/resend
Request samples
{
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b"
}

Get Tenant Users

Role Requirements

tenant-admin

Description

Gets a list of Users for the Tenant.

Securitybearer
Request
query Parameters
from
integer <int32>
Default: 0

Index position in the list to start taking from. Default is 0.

take
integer <int32>
Default: 20

Number of items to take from the list. Default is 20.

email
string

A search term for the users Email to limit the results.

header Parameters
x-account-id
required
string

The Account Id.

x-tenant-id
required
string

The Tenant Id.

x-correlation-id
string

Correlation Id for the request.

Responses
200

OK - Returns the Paged Users response.

401

Unauthorized

403

Forbidden

get/v1/tenant/users
Request samples 
Response samples 
application/json
{
  • "currentPage": 0,
  • "pageCount": 0,
  • "pageSize": 0,
  • "rowCount": 0,
  • "results": [
    • {
      • "identity": "string",
      • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
      • "emailAddress": "string",
      • "roles": [
        • "string"
        ],
      • "invitationStatus": "string",
      • "isSsoUser": true
      }
    ]
}
Get a Tenant User
Role Requirements


tenant-admin


Description


Gets a Tenant User by the userId.


Securitybearer 
Request 
path Parameters
userId
required
string <uuid> 
The User Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
200
OK - Returns the User response.


401
Unauthorized


403
Forbidden


get/v1/tenant/users/{userId}
Request samples 
Response samples 
application/json
{
  • "identity": "string",
  • "userId": "2c4a230c-5085-4924-a3e1-25fb4fc5965b",
  • "emailAddress": "string",
  • "roles": [
    • "string"
    ],
  • "invitationStatus": "string",
  • "isSsoUser": true
}
Update a Tenant User
Role Requirements


tenant-admin


Description


Updates a Tenant User by the userId.


Securitybearer 
Request 
path Parameters
userId
required
string <uuid> 
The User Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Request Body schema: 
roles
Array of strings or null
The new Roles to apply to the User.


 
Responses 
202
Accepted.


401
Unauthorized


403
Forbidden


put/v1/tenant/users/{userId}
Request samples 
{
  • "roles": [
    • "string"
    ]
}
Delete a Tenant User
Role Requirements


tenant-admin


Description


Deletes a Tenant User by the userId.


Securitybearer 
Request 
path Parameters
userId
required
string <uuid> 
The User Id.


 
header Parameters
x-account-id
required
string
The Account Id.


 
x-tenant-id
required
string
The Tenant Id.


 
x-correlation-id
string
Correlation Id for the request.


 
Responses 
204
No Content.


401
Unauthorized


403
Forbidden


delete/v1/tenant/users/{userId}
Request samples 
Copyright 2024 Duck Creek Technologies. All Rights Reserved.