latestOpenAPI 3.0.02026-08-10517386.6 KB

a9f1b102faca

App installations

Generate an installation access token

This endpoint generates an installation access token for a specific installation. This access token can be used to access organization resources.

post/app/installations/{installationId}/accessTokens

Path parameters

installationIdstring required

Headers

x-icr-api-versionstring

API version

Response

idstring required

The ID of the access token

createdAtstring date-time required

The date and time the access token was created

updatedAtstring date-time required

The date and time the access token was last updated

tokenstring required

The access token string

expiresAtstring date-time required

The date and time the access token expires

isActiveboolean required

Whether the access token is currently active

permissionsobject required

The permissions of the access token

appIdstring required

The ID of the app associated with the access token

installationIdstring required

The ID of the installation associated with the access token

organizationIdstring required

The ID of the organization associated with the access token

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2022-01-01T00:00:00Z",
  "updatedAt": "2022-01-01T00:00:00Z",
  "token": "crs_19c9bd530ccd3e1187eed12dc4edb70abe757fc4c7be9c5b",
  "expiresAt": "2022-02-01T00:00:00Z",
  "isActive": true,
  "permissions": {
    "organization_info": "VIEW",
    "organization_members": "VIEW",
    "organization_projects": "VIEW",
    "organization_inventory": "REQUEST",
    "organization_warehouse": "WRITE"
  },
  "appId": "67890",
  "installationId": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "123e4567-e89b-12d3-a456-426614174000"
}