AIaikido

List users

Returns a list of all the users

get/users

Request

  • Base URL
    https://app.aikido.dev/api/public/v1
  • URL
    https://app.aikido.dev/api/public/v1/users
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://app.aikido.io/api/oauth/token scopes: users:read

Query parameters

filter_team_idinteger

Will apply a filter to the results so they only return users in that team.

include_inactiveinteger

Includes inactive users.

Response

A list of users

idinteger

The user ID.

full_namestring

The full name of the user.

emailstring

The email of the user.

activeinteger

0 or 1 integer indicating if the user is active.

last_login_timestampinteger

Unix timestamp indicating the last time this user logged in.

rolestring

String representing the role of this user. Can be 'admin', 'default' or 'team_only'.

auth_typestring

String representing the auth type of this user. Can be 'github', 'gitlab', 'bitbucket', 'google', 'office365' or 'saml'

Example response

[
  {
    "id": 1,
    "full_name": "Wendy Snutz",
    "email": "wendysnutz@gmail.com",
    "active": 1,
    "last_login_timestamp": 1720059659,
    "role": "admin",
    "auth_type": "github"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.