Skip to main content
POST
Create a native Make Credential Request

Authorizations

Authorization
string
header
required

WorkOS access JWT or a user-owned WorkOS API key. User keys are bound to one organization and restricted to their enabled product permissions. Session-only onboarding and session revocation require an interactive access JWT. No cookie session is assumed.

Headers

X-Request-Id
string

Optional caller-provided correlation identifier.

Required string length: 1 - 128
Idempotency-Key
string
required

Identifies one mutation and its canonical request payload; only letters, digits and the characters . _ : - are accepted.

Required string length: 1 - 128
Pattern: ^[A-Za-z0-9._:-]+$

Path Parameters

organization_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$
grant_id
string
required
Pattern: ^[0-9A-HJKMNP-TV-Z]{26}$

Body

application/json
provider_organization_id
integer
required
Required range: 1 <= x <= 9007199254740991
team_id
integer
required
Required range: 1 <= x <= 9007199254740991
selections
object[]
required
Required array length: 1 - 64 elements

Response

Credential Request result and its private Make link when available.

state
enum<string>
required
Available options:
created,
running,
uncertain,
reconnect_required
request_id
string
Pattern: ^[a-f0-9]{64}$
provider_status
string
Required string length: 1 - 64
authorization_url
string<uri>

Private Make link available only on create or replay.

expires_at
string<date-time> | null