Get user types

Prev Next
Get
/identity/users/me/userTypes

Returns the list of configured user types.

Security
HTTP
Type bearer
Header parameters
X-Servitly-Tenant
stringRequired

The name of the target tenant (e.g. acme).

Query parameters
category
stringRequired

The user type category.

Valid values[ "ORGANIZATION", "PARTNER", "CUSTOMER" ]
Minimum1.0
Responses
200

Successful operation.

Array of object
object
id
string

The user-type object identifier.

name
string
category
string

The category this user type belongs to, one of ORGANIZATION, CUSTOMER, PARTNER.

rank
integer

The rank of the user type used to prevent unauthorized user reads or updates.

commandPayloadDuration
integer

The duration in milliseconds a command-payload is valid after its creation.

permissions
Array of string

The list of permissions associated with this user type.

string
401

User not authenticated.

object
message
string

The error response.

ExampleUser not authenticated
403

User not authorized.

object
message
string

The error response.

ExampleUser not authorized
404

Resource was not found.

object
message
string

The error response.

ExampleResource not found
429

API call rate limit exeeded.

object
message
string

The error response.

ExampleAPI call rate limit exeeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error