Documentation Index

Fetch the complete documentation index at: https://learn.servitly.com/llms.txt

Use this file to discover all available pages before exploring further.

Get user types

Prev Next
Get
/identity/users/me/userTypes

Returns the list of configured user types for the requested category (ORGANIZATION, CUSTOMER or PARTNER).
A user type is the role assigned to a user: it carries the set of permissions granted, the rank used to prevent the read or the update of users of a higher level, and the duration for which a command-payload stays valid after its creation.
The identifiers returned here are the ones to be used when creating users or thing authorizations.

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

The name of the 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 exceeded.

object
message
string

The error response.

ExampleAPI call rate limit exceeded
500

Internal server error.

object
message
string

The error response.

ExampleInternal Server Error