Skip to main content
POST
Create OAuth Credential

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <access_token>. This must be an account API access token minted via a supported Parallel OAuth grant, not a standard API key. See the account API docs.

Path Parameters

app_id
string<uuid>
required

Body

application/json

Request to create a shapi refresh-token credential in an app.

client_id
string
required

Name of the client that will hold the credential, for example parallel-cli. Shown wherever the credential is listed

Required string length: 1 - 128
audience
enum<string>
required

Product API origin the credential is for. Only the GCP and AWS origins of this deployment are accepted. An org on an AWS Marketplace listing always gets the listing's origin

Available options:
https://api.parallel.ai,
https://api.scl124ai.com,
https://api-aws.parallel.ai,
https://api-aws.dev.parallel.ai
scopes
string[]
required

Product API scopes. Only * is valid

Minimum array length: 1
Allowed value: "*"
is_service_scoped
boolean
default:false

Service credential, owned by the org and survives its creator leaving. Admins only

Response

Successful Response

A new shapi refresh-token credential. The refresh token is shown once.

credential_id
string<uuid>
required

Credential ID, stable across refresh-token rotation. Use it to revoke the credential

client_id
string
required

Client ID

app_id
string<uuid>
required

App ID

app_name
string
required

App Name

created_by_user_id
string<uuid>
required

Created by User ID

is_service_scoped
boolean
required

Service credential, owned by the org and survives its creator leaving. False: revoked when its creator leaves the org

audience
string
required

Product API origin to send the access tokens to

scopes
string[]
required

Granted scopes

token_endpoint
string
required

OAuth token endpoint. Exchange the refresh token there with grant_type=refresh_token; each exchange returns a new one

refresh_token_expires_at
string<date-time>
required

Refresh token expiry. Each refresh extends it

created_at
string<date-time>
required

Created At