HTTP API

Generated from the production HTTP contracts.

GET/api/v1/scim/connection

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/scim/connection"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/scim/connection

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

allowedDomains*array<>

Itemsitems <= 32

enabled*boolean

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/scim/connection" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "allowedDomains": [      "string"    ],    "enabled": true  }'

{  "data": null}

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/scim/tokens

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

connectionId*string

Length1 <= length <= 191

name*string

Length1 <= length <= 100

expiresAt*string

Match

^(?:(?:\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))$

Formatdate-time

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/scim/tokens" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "string",    "name": "string",    "expiresAt": "2019-08-24T14:15:22Z"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/scim/tokens

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

connectionId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/scim/tokens?connectionId=string"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

DELETE/api/v1/scim/tokens/{tokenId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

tokenId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

connectionId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/scim/tokens/string" \  -H "Content-Type: application/json" \  -d '{    "connectionId": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/setup

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

brandingAnimation?string

Length1 <= length <= 2048

brandingButtonRadius?string

Length1 <= length <= 2048

brandingLogoUrl?|null

consentInterstitial?boolean

devUrls?array<>

Itemsitems <= 256

enabledProviders?array<>

Itemsitems <= 4

gateSessionTtlSecs?integer

Range60 <= value <= 2592000

implicitOrgAdminAccess?boolean

remoteLoginEnabled?boolean

remoteLoginMaxTtlSecs?integer

Range60 <= value <= 86400

requiredIdentityDomains?array<>

Itemsitems <= 32

hostnames*array<>

Items1 <= items <= 256

loginTheme?__schema0|null

managedApplicationScope?string

Value in

"explicit"
"organization"

managedApplicationSlugs?array<>

Itemsitems <= 256

managedDirectoryTeamIds?array<>

Itemsitems <= 256

mode*string

Value in

"gate"
"hydrate"
"oidc"
"none"

name*string

Length1 <= length <= 100

oidcCompatibility?string

Value in

"standard"
"legacy_confidential"

oidcRedirectUris?array<>

Items1 <= items <= 10

optionsAllowlistPaths?array<>

Itemsitems <= 64

rotateClientSecret?boolean

signupPolicy*string

Value in

"open"
"invite"
"closed"

slug*string

Match^[a-z0-9](?:[a-z0-9-]*[a-z0-9])?$

Length1 <= length <= 63

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/setup" \  -H "Content-Type: application/json" \  -d '{    "hostnames": [      "string"    ],    "mode": "gate",    "name": "string",    "signupPolicy": "open",    "slug": "string"  }'

{  "data": null}

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/access/grants

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

effect*string

Value in

"allow"
"deny"

role*string

Value in

"visitor"
"member"
"reader"
"writer"
"admin"

enabledModules?array<>

Itemsitems <= 32

subjectId*string

Length1 <= length <= 1024

subjectType*string

Value in

"user"
"group"
"org_role"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/access/grants" \  -H "Content-Type: application/json" \  -d '{    "effect": "allow",    "role": "visitor",    "subjectId": "string",    "subjectType": "user"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

DELETE/api/v1/apps/{appId}/access/grants

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

subjectId*string

Length1 <= length <= 1024

subjectType*string

Value in

"user"
"group"
"org_role"

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/apps/string/access/grants" \  -H "Content-Type: application/json" \  -d '{    "subjectId": "string",    "subjectType": "user"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/groups

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 100

emailDomain?string

Match^@?(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?$

Length1 <= length <= 254

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/groups" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/groups/{groupId}/members

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

groupId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId*string

Length1 <= length <= 1024

role?string

Value in

"owner"
"admin"
"member"

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/groups/string/members" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/groups/{groupId}/members

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

groupId*string

Length1 <= length <= 191

Query Parameters

cursor?string

Length1 <= length <= 1024

limit?integer

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/groups/string/members"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/groups/{groupId}/sharing

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

groupId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

rotate?boolean

shared*boolean

sharedLabel?string

Length1 <= length <= 100

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/groups/string/sharing" \  -H "Content-Type: application/json" \  -d '{    "shared": true  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/access/cross-org-grants

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

acknowledgeGateOutage?boolean

effect*string

Value in

"allow"
"deny"

enabledModules?array<>

Itemsitems <= 32

role*string

Value in

"visitor"
"member"
"reader"
"writer"
"admin"

sharedReference*string

Match^xgr_[0-9a-f]{32}$

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/access/cross-org-grants" \  -H "Content-Type: application/json" \  -d '{    "effect": "allow",    "role": "visitor",    "sharedReference": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/access/cross-org-grants

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/access/cross-org-grants"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

DELETE/api/v1/apps/{appId}/access/cross-org-grants/{grantId}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

grantId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/apps/string/access/cross-org-grants/string"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/modules

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

description?|null

key*string

Match^[a-z][a-z0-9_]*$

Length1 <= length <= 63

label*string

Length1 <= length <= 100

position?integer

Range0 <= value <= 9999

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/modules" \  -H "Content-Type: application/json" \  -d '{    "key": "string",    "label": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/modules

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/modules"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

DELETE/api/v1/apps/{appId}/modules/{moduleKey}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

moduleKey*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X DELETE "https://example.com/api/v1/apps/string/modules/string"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/grants/share-links

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expiresAt?string

Match

^(?:(?:\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))$

Formatdate-time

maxUses?integer

Range0 < value <= 1000000

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/grants/share-links" \  -H "Content-Type: application/json" \  -d '{}'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/grants/{grantId}/rotate

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

grantId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/grants/string/rotate"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/ingress-snippet

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/ingress-snippet"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/access/resolve

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

userId*string

Length1 <= length <= 1024

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/access/resolve" \  -H "Content-Type: application/json" \  -d '{    "userId": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/audit

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

appId?string

Length1 <= length <= 191

cursor?string

Length1 <= length <= 512

event?string

Length1 <= length <= 128

from?string

Match

^(?:(?:\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))$

Formatdate-time

limit?integer

Range1 <= value <= 100

to?string

Match

^(?:(?:\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))$

Formatdate-time

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/audit"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/directory

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Query Parameters

cursor?string

Length1 <= length <= 512

limit?integer

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/directory"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/access/catalog

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Query Parameters

appCursor?string

Length1 <= length <= 1024

appLimit?integer

Range1 <= value <= 100

userCursor?string

Length1 <= length <= 1024

userLimit?integer

Range1 <= value <= 100

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/access/catalog"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/access/matrix

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

applications*array<>

Items1 <= items <= 32

people*array<>

Items1 <= items <= 32

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/access/matrix" \  -H "Content-Type: application/json" \  -d '{    "applications": [      "string"    ],    "people": [      "string"    ]  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/saml/request-signing

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/saml/request-signing"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

GET/api/v1/apps/{appId}/saml/connection

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X GET "https://example.com/api/v1/apps/string/saml/connection"

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/apps/{appId}/saml/connection

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

expectedRevision*integer

Range0 <= value <= 9007199254740991

metadataXml*string

Length1 <= length <= 131072

nameIdFormat?string

Value in

"persistent"
"emailAddress"
"unspecified"
"transient"

selectedAcsUrl*string

Formaturi

Lengthlength <= 2048

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/apps/string/saml/connection" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0,    "metadataXml": "string",    "selectedAcsUrl": "http://example.com"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/apps/{appId}/saml/connection/state

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

admissionEmail*string

Match^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

Formatemail

Lengthlength <= 320

desiredState*string

expectedResponseSigningCertificateSha256*string

Match^[0-9a-f]{64}$

expectedRevision*integer

Range0 <= value <= 9007199254740991

nameIdFormat?string

Value in

"persistent"
"emailAddress"
"unspecified"
"transient"

requireSignedAuthnRequests?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/apps/string/saml/connection/state" \  -H "Content-Type: application/json" \  -d '{    "admissionEmail": "[email protected]",    "desiredState": "prepared",    "expectedResponseSigningCertificateSha256": "string",    "expectedRevision": 0  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/apps/{appId}/saml/request-signing

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

certificatePem?string

Length1 <= length <= 16384

expectedRevision*integer

Range0 <= value <= 9007199254740991

removePublicKeySha256?string

Match^[0-9a-f]{64}$

requireSignedAuthnRequests?boolean

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/apps/string/saml/request-signing" \  -H "Content-Type: application/json" \  -d '{    "expectedRevision": 0  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

PUT/api/v1/apps/{appId}/credentials/{provider}

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

provider*string

Value in

"google"
"github"
"discord"
"twitter"
"resend"

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

credential*string

Length1 <= length <= 16384

Response Body

`application/json`

curl -X PUT "https://example.com/api/v1/apps/string/credentials/google" \  -H "Content-Type: application/json" \  -d '{    "credential": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/vault/token

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

provider*string

Value in

"google"
"github"
"discord"
"twitter"

userId*string

Length1 <= length <= 191

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/vault/token" \  -H "Content-Type: application/json" \  -d '{    "provider": "google",    "userId": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

POST/api/v1/apps/{appId}/step-up/consume

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Path Parameters

appId*string

Length1 <= length <= 191

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

proof*string

Length32 <= length <= 8192

state*string

Match^[A-Za-z0-9_-]{43,256}$

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/apps/string/step-up/consume" \  -H "Content-Type: application/json" \  -d '{    "proof": "stringstringstringstringstringst",    "state": "string"  }'

{  "data": null}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

{  "error": {    "code": "string",    "message": "string"  }}

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

500application/json

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/json

415application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/json

415application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

415application/json

500application/json

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/json

415application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/json

415application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

413application/json

415application/json

500application/json

201application/json

400application/json

401application/json

403application/json

409application/json

413application/json

415application/json

500application/json

200application/json

400application/json

401application/json

403application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`