HTTP API

Generated from the production HTTP contracts.

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

hostnames*array<>

Items1 <= items <= 256

loginTheme?__schema0|null

mode*string

Value in

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

name*string

Length1 <= length <= 100

signupPolicy*string

Value in

"open"
"invite"
"closed"

silentSsoPaths?array<>

Itemsitems <= 256

slug*string

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

Length1 <= length <= 63

visitorHydration?boolean

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"

subjectId*string

Length1 <= length <= 191

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"  }}

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

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 <= 191

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"  }}

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"  }}

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"  }}

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 <= 191

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"  }}

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"  }}

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"  }}

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"  }}

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

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

404application/json

413application/json

415application/json

500application/json

201application/json

400application/json

401application/json

403application/json

404application/json

413application/json

415application/json

500application/json

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

413application/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

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

`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`