Apps

Generate an app access token

This endpoint generates an app access token. This access token can be used to access app specific resources and general "public" resources, like the /projects endpoint.

post/app/accessTokens

Request

Base URL
https://api.carbonregistry.com
Auth
none declared
TypeScript
https://skmtc.dev/carbonregistry/apis/carbon-registry-rest-api/docs/app/accessTokens/post.ts
A function with typed inputs. Its response is checked against the schema.

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

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"
}

Changes

No recorded changes to this operation across all 1 revision of this API.