User

Manage organization users and membership.

Get organizations users

get
/organizations/{organizationId}/users

Get organizations users by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
usernamestringOptional

Username

sortstringOptional

Sort

Example: {"value":"createdAt"}
limitintegerOptional

The limit of per page

Default: 10
pageintegerOptional

Current page number

Default: 1
statusstringOptional

Status

rolestringOptional

Role ID

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/users

Create a organization user

post
/organizations/{organizationId}/users

Create a organization user by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
userall ofRequired
stringOptional
and
anyOptional

User id

and
stringOptional

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
post
/organizations/{organizationId}/users

Search organizations users

get
/organizations/{organizationId}/users/search/availables

Search organizations users by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Query parameters
textstringOptional

Text

Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/users/search/availables

Get a organization user

get
/organizations/{organizationId}/users/{userId}

Get a organization user by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
userIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
chevron-right
200

OK

application/json
get
/organizations/{organizationId}/users/{userId}

Update a organization user

put
/organizations/{organizationId}/users/{userId}

Update a organization user by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
userIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Body
Responses
chevron-right
200

OK

application/json
put
/organizations/{organizationId}/users/{userId}

Delete a organization user

delete
/organizations/{organizationId}/users/{userId}

Delete a organization user by organization user

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
userIdstringRequired

Entity ID

Pattern: ^[0-9a-fA-F]{24}$
Responses
delete
/organizations/{organizationId}/users/{userId}

No content

Last updated

Was this helpful?