List service accounts.

GET 
/api/admin/service-account

Returns the list of all service accounts.

Responses

200

#/components/schemas/serviceAccountsSchema

application/json

Schema

Schema

serviceAccounts

object[]

required

A list of service accounts

Array [

id numberrequired

The service account id

Example: 54321

isAPI booleandeprecated

Deprecated: for internal use only, should not be exposed through the API

Example: false

name string

The name of the service account

Example: My Service Account

email stringdeprecated

Deprecated: service accounts don't have emails associated with them

Example: noemail@getunleash.io

username string

The service account username

Example: my-service-account

imageUrl string

The service account image url

Example: https://example.com/my-service-account.png

inviteLink stringdeprecated

Deprecated: service accounts cannot be invited via an invitation link

Example: https://example.com/invite-link

loginAttempts numberdeprecated

Deprecated: service accounts cannot log in to Unleash

Example: 0

emailSent booleandeprecated

Deprecated: internal use only

Example: false

rootRole integer

The root role id associated with the service account

Example: 1

seenAt date-timenullabledeprecated

Deprecated. This property is always null. To find out when a service account was last seen, check its tokens list and refer to each token's lastSeen property instead.

Example: null

createdAt date-time

The service account creation date

Example: 2021-01-01T00:00:00.000Z

tokens

object[]

The list of tokens associated with the service account

Array [

id integerrequired

The PAT's ID. PAT IDs are incrementing integers. In other words, a more recently created PAT will always have a higher ID than an older one.

Possible values: >= 1

Example: 1

secret string

The token used for authentication. It is automatically generated by Unleash when the PAT is created and that is the only time this property is returned.

Example: user:xyzrandomstring

createdAt date-timerequired

The date and time of when the PAT was created.

Example: 2023-04-19T08:15:14.000Z

seenAt date-timenullable

When the PAT was last seen/used to authenticate with. null if it has not been used yet.

Example: 2023-04-19T08:15:14.000Z

userId integer

The ID of the user this PAT belongs to.

Example: 1337

description stringrequired

The PAT's description.

Example: user:xyzrandomstring

expiresAt date-timerequired

The PAT's expiration date.

Example: 2023-04-19T08:15:14.000Z

]

]

rootRoles

object[]

A list of root roles that are referenced from service account objects in the serviceAccounts list

Array [

id integerrequired

The role id

Example: 9

type stringrequired

A role can either be a global root role (applies to all projects) or a project role

Example: root

name stringrequired

The name of the role

Example: Editor

description string

A more detailed description of the role and what use it's intended for

Example: Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.

project stringnullable

What project the role belongs to

Example: default

]

Example (from schema)

{
  "serviceAccounts": [
    {
      "id": 54321,
      "name": "My Service Account",
      "username": "my-service-account",
      "imageUrl": "https://example.com/my-service-account.png",
      "rootRole": 1,
      "createdAt": "2021-01-01T00:00:00.000Z",
      "tokens": [
        {
          "id": 1,
          "secret": "user:xyzrandomstring",
          "createdAt": "2023-04-19T08:15:14.000Z",
          "seenAt": "2023-04-19T08:15:14.000Z",
          "userId": 1337,
          "description": "user:xyzrandomstring",
          "expiresAt": "2023-04-19T08:15:14.000Z"
        }
      ]
    }
  ],
  "rootRoles": [
    {
      "id": 9,
      "type": "root",
      "name": "Editor",
      "description": "Users with the editor role have access to most features in Unleash but can not manage users and roles in the global scope. Editors will be added as project owners when creating projects and get superuser rights within the context of these projects. Users with the editor role will also get access to most permissions on the default project by default.",
      "project": "default"
    }
  ]
}

401

Authorization information is missing or invalid. Provide a valid API token as the authorization header, e.g. authorization:*.*.my-admin-token.

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: AuthenticationRequired
message string
A description of what went wrong.
Example: You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "AuthenticationRequired",
  "message": "You must log in to use Unleash. Your request had no authorization header, so we could not authorize you. Try logging in at /auth/simple/login."
}

403

The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation

application/json

Schema

Schema

id string
The ID of the error instance
Example: 9c40958a-daac-400e-98fb-3bb438567008
name string
The name of the error kind
Example: NoAccessError
message string
A description of what went wrong.
Example: You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.

Example (from schema)

{
  "id": "9c40958a-daac-400e-98fb-3bb438567008",
  "name": "NoAccessError",
  "message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}

Loading...