BLblackkitetech
User

Get the list of users.

Changed on

Get the list of users listed on the Black Kite system. The list reflects what the user who created this credential sees on the User Management page: users whose authority exceeds theirs are not returned, and Platform Admins, Multi-tenant Admins, Collaborators and Demo Company Users are never returned.

get/api/v2/users

Request

Query parameters

page_numberinteger
Example:1

The number of the page requested.

page_size10 | 20 | 30
Example:10

The number of result items in a single response.

emailstring
Example:john.doe@acmeinc.com

The exact value of the email address of a user. No wildcard matching or contains is applied.

rolestring[]

A single or comma separated value of user role. When omitted no role filter is applied and the list is the full view of the credential creator. NotApplicable returns the users who are only associated with a group and none of the legacy roles.

statusstring[]

A single or comma separated value of user status.

Response

Success

UserIdinteger

The ID of the user.

FullNamestring

The name of the user.

Emailstring

Email of the user.

PhoneNumberstring nullable

Phone number of the user.

LastLoginDatestring date-time nullable

The date time that the user's last login to the Black Kite platform.

Creatorstring

The information about the source where the user registered in the system. This value sometimes contains an email, sometimes only the source information.

Status'Active' | 'Inactive' | 'Deleted'

The status information of the user.

Role'Super Admin' | 'Super User' | 'Ecosystem Admin' | 'Ecosystem User' | 'Company Admin' | 'Company User' | 'NOT APPLICABLE'

The role information of the user. NOT APPLICABLE means that the user is only associated with a group and none of the legacy roles. A legacy role counts only while an active RBAC assignment still backs it, so the shadow Company User row written when a user is created does not count.

Example response

[
  {
    "UserId": 22,
    "FullName": "John Doe",
    "Email": "john.doe@acmeinc.com",
    "PhoneNumber": "806271728858254",
    "LastLoginDate": "2021-08-09T08:30:30.682Z",
    "Creator": "SYSTEM",
    "Status": "Active",
    "Role": "Super Admin",
    "AuthorizedEntities": [
      {
        "Id": 173,
        "Name": "MyCompanies"
      }
    ],
    "Groups": [
      {
        "GroupId": 412,
        "GroupName": "Vendor Managers"
      }
    ]
  }
]

Changes

  • 1fa174efb09aRevision changes
    • warning

      added the new NOT APPLICABLE enum value to the / response property for the response status

    • info

      added the enum value NotApplicable to the property items/ of the query request parameter role

    • info

      added the optional property / to the response with the status