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

200

application/json

totalDocsintegerRequired

The total number of users

limitintegerRequired

The limit of users per page

Default: 10

pageintegerRequired

Current page

Default: 1

totalPagesintegerRequired

The total number of pages

pagingCounterintegerRequired

Current page number

hasPrevPagebooleanRequired

Has previous page

hasNextPagebooleanRequired

Has next page

prevPageintegerRequired

Previous page number

nextPageintegerRequired

Next page number

401

Unauthorized

application/json

403

Forbidden

application/json

get/organizations/{organizationId}/users

GET /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

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

201

Created

application/json

and

400

Bad Request

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post/organizations/{organizationId}/users

POST /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": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "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": "2026-01-01T00:00:00.000Z",
        "updatedAt": "2026-01-01T00:00:00.000Z"
      },
      "privileges": [
        "project:read",
        "project:write"
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z"
    },
    {
      "organization": "text"
    }
  ]
}

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

200

application/json

totalDocsintegerRequired

The total number of users

limitintegerRequired

The limit of users per page

Default: 10

pageintegerRequired

Current page

Default: 1

totalPagesintegerRequired

The total number of pages

pagingCounterintegerRequired

Current page number

hasPrevPagebooleanRequired

Has previous page

hasNextPagebooleanRequired

Has next page

prevPageintegerRequired

Previous page number

nextPageintegerRequired

Next page number

401

Unauthorized

application/json

403

Forbidden

application/json

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

GET /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

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

200

application/json

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": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "roles": []
}

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

200

application/json

_idstringRequired

Entity ID

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

usernamestring · min: 5 · max: 255Required

User username (email)

passwordstring · min: 3 · max: 255Write-onlyRequired

User password

languagestringOptional

User ISO 639-1 language code

regionstringOptional

User ISO 3166-1 alpha-2 region code

firstNamestring · min: 5 · max: 255Required

User first name

lastNamestring · min: 5 · max: 255Required

User last name

statusinteger · enumRequired

Status

Possible values:

attributesobjectOptional

User attributes

avatarUrlstringOptional

User avatar URL

lastLoginAtstring · date-timeRead-onlyRequired

Date

createdAtstring · date-timeRead-onlyRequired

Date

updatedAtstring · date-timeRead-onlyRequired

Date

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": "2026-01-01T00:00:00.000Z",
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z"
}

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

204

No Content

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

PreviousRole

NextInvitation

Last updated 10 months ago

Was this helpful?