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
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
get
/organizations/{organizationId}/usersGET /api/v1/organizations/{organizationId}/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalDocs": 1,
"limit": 10,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 1,
"nextPage": 1,
"docs": []
}Create 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}/usersPOST /api/v1/organizations/{organizationId}/users HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 44
{
"user": "text",
"roles": [
"text",
null,
"text"
]
}{
"_id": "text",
"username": "text",
"language": "text",
"region": "text",
"firstName": "text",
"lastName": "text",
"status": 0,
"attributes": {},
"avatarUrl": "text",
"settings": {
"mailOnBuildCompleted": true,
"mailOnCodePushCompleted": true
},
"lastLoginAt": "2025-12-06T10:11:20.534Z",
"createdAt": "2025-12-06T10:11:20.534Z",
"updatedAt": "2025-12-06T10:11:20.534Z",
"organization": "text",
"roles": [
{
"_id": "text",
"name": "text",
"description": "text",
"organization": {
"_id": "text",
"name": "text",
"slug": "text",
"description": "text",
"owner": "text",
"isExecutive": false,
"status": 0,
"privileges": [
"project:read",
"project:write"
],
"imageUrl": "text",
"createdAt": "2025-12-06T10:11:20.534Z",
"updatedAt": "2025-12-06T10:11:20.534Z"
},
"privileges": [
"project:read",
"project:write"
],
"createdAt": "2025-12-06T10:11:20.534Z",
"updatedAt": "2025-12-06T10:11:20.534Z"
},
{
"organization": "text"
}
]
}Search 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
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
get
/organizations/{organizationId}/users/search/availablesGET /api/v1/organizations/{organizationId}/users/search/availables HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"totalDocs": 1,
"limit": 10,
"page": 1,
"totalPages": 1,
"pagingCounter": 1,
"hasPrevPage": true,
"hasNextPage": true,
"prevPage": 1,
"nextPage": 1,
"docs": []
}Get 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
Responseall of
and
401
Unauthorized
application/json
403
Forbidden
application/json
404
Not Found
application/json
get
/organizations/{organizationId}/users/{userId}GET /api/v1/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"_id": "text",
"username": "text",
"language": "text",
"region": "text",
"firstName": "text",
"lastName": "text",
"status": 0,
"attributes": {},
"avatarUrl": "text",
"settings": {
"mailOnBuildCompleted": true,
"mailOnCodePushCompleted": true
},
"lastLoginAt": "2025-12-06T10:11:20.534Z",
"createdAt": "2025-12-06T10:11:20.534Z",
"updatedAt": "2025-12-06T10:11:20.534Z",
"roles": []
}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}PUT /api/v1/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 30
{
"roles": [
"text",
null,
"text"
]
}{
"_id": "text",
"username": "text",
"language": "text",
"region": "text",
"firstName": "text",
"lastName": "text",
"status": 0,
"attributes": {},
"avatarUrl": "text",
"settings": {
"mailOnBuildCompleted": true,
"mailOnCodePushCompleted": true
},
"lastLoginAt": "2025-12-06T10:11:20.534Z",
"createdAt": "2025-12-06T10:11:20.534Z",
"updatedAt": "2025-12-06T10:11:20.534Z"
}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}DELETE /api/v1/organizations/{organizationId}/users/{userId} HTTP/1.1
Host: abp-api.akinon.net
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?

