Skip to content

Admin

An API Administering the Blackbird AI Platform.

Download OpenAPI description
admin.json
admin.yaml
Languages
Servers
https://api.blackbird.ai/admin

users

Operations

List all users in the organization

Request

Retrieves all users in the organization (Reconciliation endpoint). This endpoint allows organization administrators to reconcile their user list with internal identity management systems.

Security
clientCredentials
Query
emailstring(email)

The email of the user to filter the list

curl -i -X GET \
  'https://api.blackbird.ai/admin/admin/users?email=user%40example.com' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of users with their ID, email, active status, and relationships

Bodyapplication/json
bodyArray of objects(UserResource)required

Array of user resources

body[].​idstringrequired

The resource ID

body[].​emailstring(email)required

The email address of the user

body[].​rolesArray of strings(Role)required

The roles the user has

Items Value"leadAnalyst"
body[].​statusstringrequired

Whether the user is active or deactivated

body[].​firstNamestring

The first name of the user

body[].​lastNamestring

The last name of the user

Response
application/json
{
  "body": [
    { … }
  ]
}

Creates a user

Request

Creates a user with the given email and in the caller's organization.

Security
clientCredentials
Bodyapplication/jsonrequired

A user to create

emailstring(email)required

The email address of the user

statusstring

Whether the user is active or deactivated

Default "active"
Enum"active""deactivated"
lastNamestring

The last name of the user

firstNamestring

The first names of the user

suppressWelcomeEmailboolean

Prevents welcome email sending

appRootUrlstring

App root url to redirect users too. Not used when suppressWelcomeEmail is true.

pageUrlstring

Page url to redirect users too. Not used when suppressWelcomeEmail is true.

Default "reset-password"
curl -i -X POST \
  https://api.blackbird.ai/admin/admin/users \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "user@example.com",
    "status": "active",
    "lastName": "string",
    "firstName": "string",
    "suppressWelcomeEmail": true,
    "appRootUrl": "string",
    "pageUrl": "reset-password"
  }'

Responses

User created successfully

Bodyapplication/json
idstringrequired

The resource ID

emailstring(email)required

The email address of the user

rolesArray of strings(Role)required

The roles the user has

Items Value"leadAnalyst"
statusstringrequired

Whether the user is active or deactivated

firstNamestring

The first name of the user

lastNamestring

The last name of the user

Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "roles": [
    "leadAnalyst"
  ],
  "status": "string",
  "firstName": "string",
  "lastName": "string"
}

Get a specific user

Request

Retrieves a specific user by ID within the organization.

Security
clientCredentials
Path
idstringrequired

The ID of the user to retrieve

curl -i -X GET \
  'https://api.blackbird.ai/admin/admin/users/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

User details

Bodyapplication/json
idstringrequired

The resource ID

emailstring(email)required

The email address of the user

rolesArray of strings(Role)required

The roles the user has

Items Value"leadAnalyst"
statusstringrequired

Whether the user is active or deactivated

firstNamestring

The first name of the user

lastNamestring

The last name of the user

Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "roles": [
    "leadAnalyst"
  ],
  "status": "string",
  "firstName": "string",
  "lastName": "string"
}

Update a user's active status

Request

Updates a user's active status using json-merge-patch format.

Security
clientCredentials
Path
idstringrequired

The ID of the user to update

Bodyapplication/jsonrequired

Updating user's active status

idstringrequired

The ID of the user to update

statusstringrequired

Whether the user is active or deactivated

Enum"active""deactivated"
lastNamestring

The last name of the user

firstNamestring

The first name of the user

curl -i -X PUT \
  'https://api.blackbird.ai/admin/admin/users/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "id": "string",
    "status": "active",
    "lastName": "string",
    "firstName": "string"
  }'

Responses

User updated successfully

Bodyapplication/json
idstringrequired

The resource ID

emailstring(email)required

The email address of the user

rolesArray of strings(Role)required

The roles the user has

Items Value"leadAnalyst"
statusstringrequired

Whether the user is active or deactivated

firstNamestring

The first name of the user

lastNamestring

The last name of the user

Response
application/json
{
  "id": "string",
  "email": "user@example.com",
  "roles": [
    "leadAnalyst"
  ],
  "status": "string",
  "firstName": "string",
  "lastName": "string"
}

Get available user roles

Request

Retrieves a list of available user roles that can be assigned to users.

Security
clientCredentials
curl -i -X GET \
  https://api.blackbird.ai/admin/admin/roles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of available roles

Bodyapplication/json
bodyArray of objects(RoleResource)required

Array of role resources

body[].​roleNamestringrequired

The unique identifier for the role

body[].​displayNamestringrequired

The human-readable display name for the role

Response
application/json
{
  "body": [
    { … }
  ]
}