Skip to main content

Create a service account.

POST /api/admin/service-account

Creates a new service account.





  • username string

    The username of the service account

  • name string

    The name of the service account

  • rootRole integer required

    The id of the root role for the service account


The resource was successfully created.

Response Headers
  • location string

    The location of the newly created resource.

  • id number required

    The service account id

  • isAPI boolean deprecated

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

  • name string

    The name of the service account

  • email string deprecated

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

  • username string

    The service account username

  • imageUrl string

    The service account image url

  • inviteLink string deprecated

    Deprecated: service accounts cannot be invited via an invitation link

  • loginAttempts number deprecated

    Deprecated: service accounts cannot log in to Unleash

  • emailSent boolean deprecated

    Deprecated: internal use only

  • rootRole integer

    The root role id associated with the service account

  • seenAt date-time nullable 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.

  • createdAt date-time

    The service account creation date

  • tokens object[]

    The list of tokens associated with the service account

  • Array [
  • id integer required

    Possible values: >= 1

    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.

  • 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.

  • createdAt date-time required

    The date and time of when the PAT was created.

  • seenAt date-time nullable

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

  • userId integer

    The ID of the user this PAT belongs to.

  • description string required

    The PAT's description.

  • expiresAt date-time required

    The PAT's expiration date.

  • ]