Sign in
Service tokens

Create a service token

Create a new service token for the organization.

Authorization

A service token must have at least one of the following access in order to use this API endpoint:

Service Token Accesses write_service_tokens

post/organizations/{organization}/service-tokens

Path parameters

organizationstring required

The name of the organization

Request body

namestring

The name of the service token

ttlinteger

Time to live (in seconds) for the service token. The token will be invalid when TTL has passed

Response

Returns the created service token with the plaintext token

idstring required

The ID of the service token

namestring nullable required

The name of the service token

display_namestring required

The display name of the service token

tokenstring nullable

The plaintext token. Available only after create.

plain_text_refresh_tokenstring nullable

The plaintext refresh token. Available only after create.

avatar_urlstring required

The image source for the avatar of the service token

created_atstring required

When the service token was created

updated_atstring required

When the service token was last updated

expires_atstring nullable required

When the service token will expire

last_used_atstring nullable required

When the service token was last used

actor_idstring nullable required

The ID of the actor on whose behalf the service token was created

actor_display_namestring nullable required

The name of the actor on whose behalf the service token was created

actor_typestring nullable required

The type of the actor on whose behalf the service token was created

Changes

Changed in 3 of the 25 revisions of this API.152

  • 72506953f36715See the full diff
    • ▲

      the response property actor_display_name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property actor_id became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property actor_type became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property expires_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property last_used_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property name became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property oauth_accesses_by_resource became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property plain_text_refresh_token became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property service_token_accesses became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property service_token_accesses/items/resource/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property token became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property oauth_accesses_by_resource became optional for the status 200

      response-property-became-optional

    • ▲

      the response property plain_text_refresh_token became optional for the status 200

      response-property-became-optional

    • ▲

      the response property service_token_accesses became optional for the status 200

      response-property-became-optional

    • ▲

      the response property token became optional for the status 200

      response-property-became-optional

  • dc925104456c1See the full diff
    • ○

      added the new optional request property ttl

      new-optional-request-property

  • 5e881928d77a1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog