Issue a project-scoped token
Send a permission preset or explicit permissions to create a token limited to this project and any listed projectIds. Send the returned token in the X-Scoped-Token header. Tokens last at most six hours and cannot issue other tokens.
Authorizations
Enter ApiKey <your-api-key> in Authorization, including the ApiKey prefix. In cURL and Python samples, <api-key> means this full value. The TypeScript SDK adds the prefix for you.
Path Parameters
Project ID with prefix pp..
^pp\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Body
- Option 1
- Option 2
A named permission set: read (Read everything), write (Read and write, no spending), deploy (Read, write and launch runs that spend money), labeling-read (Data labeling: read), labeling-write (Data labeling: read and write, no spending), labeling-deploy (Data labeling: read, write and launch pipelines).
read, write, deploy, labeling-read, labeling-write, labeling-deploy Token lifetime in seconds, from 60 to 21600; defaults to 21600.
60 <= x <= 21600Further projects the token may act in; the project in the path is always included. All projects must belong to the same team.
20Project ID with prefix pp..
^pp\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$Response
Token issued
When the token stops working.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Public handle of the token; use it to revoke without holding the secret.
^pst\.[0-9a-f]{8}-[0-9a-f]{4}-[7][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$The access token. Returned only when created; save it before closing the response.