User
Manage organization users and membership.
Get organizations users by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Query parameters
usernamestringOptional
Username
sortstringOptionalExample:
Sort
{"value":"createdAt"}limitintegerOptionalDefault:
The limit of per page
10pageintegerOptionalDefault:
Current page number
1statusstringOptional
Status
rolestringOptional
Role ID
Responses
200
OK
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
get
/organizations/{organizationId}/usersCreate a organization user by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Body
userall ofRequired
stringOptional
anyOptional
User id
stringOptionalPattern:
Entity ID
^[0-9a-fA-F]{24}$Responses
201
Created
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
post
/organizations/{organizationId}/usersSearch organizations users by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Query parameters
textstringOptional
Text
Responses
200
OK
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
get
/organizations/{organizationId}/users/search/availablesGet a organization user by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$userIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Responses
200
OK
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
/organizations/{organizationId}/users/{userId}Update a organization user by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$userIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Body
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
put
/organizations/{organizationId}/users/{userId}Delete a organization user by organization user
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$userIdstringRequiredPattern:
Entity ID
^[0-9a-fA-F]{24}$Responses
204
No Content
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
delete
/organizations/{organizationId}/users/{userId}No content
Last updated
Was this helpful?

