Create a service account.

POST

https://app.unleash-instance.example.com/api/admin/service-account

POST

/api/admin/service-account

$ curl -X POST https://app.unleash-instance.example.com/api/admin/service-account \
>      -H "Authorization: <apiKey>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "username": "service-account-1",
>   "name": "Service Account 1",
>   "rootRole": 1
> }'

1 {
2   "id": 54321,
3   "name": "My Service Account",
4   "username": "my-service-account",
5   "imageUrl": "https://example.com/my-service-account.png",
6   "rootRole": 1,
7   "createdAt": "2021-01-01T00:00:00.000Z",
8   "tokens": [
9     {
10       "id": 1,
11       "createdAt": "2023-04-19T08:15:14.000Z",
12       "description": "user:xyzrandomstring",
13       "expiresAt": "2023-04-19T08:15:14.000Z",
14       "secret": "user:xyzrandomstring",
15       "seenAt": "2023-04-19T08:15:14.000Z",
16       "userId": 1337
17     }
18   ],
19   "isAPI": false,
20   "email": "noemail@getunleash.io",
21   "inviteLink": "https://example.com/invite-link",
22   "loginAttempts": 0,
23   "emailSent": false,
24   "seenAt": null
25 }

Enterprise feature

Creates a new service account.

Authentication

Authorizationstring

API key needed to access this API

AuthorizationBearer

API key needed to access this API, in Bearer token format

Request

#/components/schemas/createServiceAccountSchema

usernamestringRequired

The username of the service account

namestringRequired

The name of the service account

rootRoleintegerRequired

The id of the root role for the service account

Response headers

locationstringOptional

The location of the newly created resource.

Response

The resource was successfully created.

iddouble

The service account id

namestringOptional

The name of the service account

usernamestringOptional

The service account username

imageUrlstringOptional

The service account image url

rootRoleintegerOptional

The root role id associated with the service account

createdAtstringOptionalformat: "date-time"

The service account creation date

tokenslist of objectsOptional

The list of tokens associated with the service account

isAPIbooleanOptionalDeprecated

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

emailstringOptionalDeprecated

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

inviteLinkstringOptionalDeprecated

Deprecated: service accounts cannot be invited via an invitation link

loginAttemptsdoubleOptionalDeprecated

Deprecated: service accounts cannot log in to Unleash

emailSentbooleanOptionalDeprecated

Deprecated: internal use only

seenAtstring or nullOptionalformat: "date-time"Deprecated

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.

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

409

Conflict Error

415

Unsupported Media Type Error