List service accounts.
GET/api/admin/service-account
Returns the list of all service accounts.
Responses
- 200
- 401
- 403
#/components/schemas/serviceAccountsSchema
- application/json
- Schema
- Example (from schema)
Schema
Array [
Array [
]
]
Array [
]
serviceAccounts
object[]
required
A list of service accounts
The service account id
54321
Deprecated: for internal use only, should not be exposed through the API
false
The name of the service account
My Service Account
Deprecated: service accounts don't have emails associated with them
noemail@getunleash.io
The service account username
my-service-account
The service account image url
https://example.com/my-service-account.png
Deprecated: service accounts cannot be invited via an invitation link
https://example.com/invite-link
Deprecated: service accounts cannot log in to Unleash
0
Deprecated: internal use only
false
The root role id associated with the service account
1
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.
null
The service account creation date
2021-01-01T00:00:00.000Z
tokens
object[]
The list of tokens associated with the service account
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
1
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.
user:xyzrandomstring
The date and time of when the PAT was created.
2023-04-19T08:15:14.000Z
When the PAT was last seen/used to authenticate with. null
if it has not been used yet.
2023-04-19T08:15:14.000Z
The ID of the user this PAT belongs to.
1337
The PAT's description.
user:xyzrandomstring
The PAT's expiration date.
2023-04-19T08:15:14.000Z
rootRoles
object[]
A list of root roles that are referenced from service account objects in the serviceAccounts
list
The role id
9
A role can either be a global root role (applies to all projects) or a project role
root
The name of the role
Editor
A more detailed description of the role and what use it's intended for
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.
What project the role belongs to
default
{
"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"
}
]
}
Authorization information is missing or invalid. Provide a valid API token as the authorization
header, e.g. authorization:*.*.my-admin-token
.
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
AuthenticationRequired
A description of what went wrong.
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.
{
"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."
}
The provided user credentials are valid, but the user does not have the necessary permissions to perform this operation
- application/json
- Schema
- Example (from schema)
Schema
The ID of the error instance
9c40958a-daac-400e-98fb-3bb438567008
The name of the error kind
NoAccessError
A description of what went wrong.
You need the "UPDATE_ADDON" permission to perform this action in the "development" environment.
{
"id": "9c40958a-daac-400e-98fb-3bb438567008",
"name": "NoAccessError",
"message": "You need the \"UPDATE_ADDON\" permission to perform this action in the \"development\" environment."
}