Skip to main content
POST
auth.enterprise-connection.create

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
organizationRef
string
required

Your own label for the customer whose staff sign in through this connection.

Required string length: 1 - 256
name
string
required

A name for the connection, 1 to 64 characters.

Required string length: 1 - 64
issuer
string
required

The identity provider's issuer address, exactly as its discovery document states it.

Required string length: 9 - 512
clientId
string
required

The client id your customer registered for your app.

Required string length: 1 - 512
tokenAuthMethod
enum<string>
required

How the client proves itself when redeeming a code; none for a public client.

Available options:
client_secret_basic,
client_secret_post,
none
redirectUris
string[]
required

The exact redirect addresses sign-in may return to, 1 to 20. No wildcards.

Required array length: 1 - 20 elements

One exact https redirect address of your app.

Maximum string length: 512
clientSecret
string

The client secret, when the client has one. Write-only: never returned.

Required string length: 1 - 2048
endpointHosts
string[]

Other hosts the identity provider's sign-in, token and key addresses may be on, up to 5. Leave out when they are all on the issuer's own host.

Maximum array length: 5

A host name.

Pattern: ^(?=.{1,253}$)([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z][a-z0-9-]{0,61}[a-z0-9]$

Response

The result

organizationRef
string
required

Your own label for the customer this connection is for.

name
string
required

The name you gave the connection.

status
string
required

The connection passed its set-up check.

Allowed value: "ready"
createdAt
string
required

When the connection was created, ISO 8601.

ref
string

Reference to what this call created. Pass it as ref to auth.enterprise-connection.delete, and as connectionRef to auth.enterprise.start and auth.social.exchange.