Skip to main content
Documentation Powered by Redocly

Logto Core (0.1.0)

Download OpenAPI specification:Download

Interaction

/api/interaction

Request Body schema: application/json
event
required
string
Enum: "SignIn" "Register" "ForgotPassword"
object or object or object or object or object or object or object or object
object

Responses

Request samples

Content type
application/json
{
  • "event": "SignIn",
  • "identifier": {
    },
  • "profile": {
    }
}

/api/interaction

Responses

/api/interaction/event

Request Body schema: application/json
event
required
string
Enum: "SignIn" "Register" "ForgotPassword"

Responses

Request samples

Content type
application/json
{
  • "event": "SignIn"
}

/api/interaction/identifiers

Request Body schema: application/json
One of
username
required
string non-empty
password
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "connectorId": "string",
  • "phone": "string"
}

/api/interaction/profile

Request Body schema: application/json
username
string <regex> /^[A-Z_a-z]\w*$/
email
string <regex> /^\S+@\S+\.\S+$/
phone
string <regex> /^\d+$/
connectorId
string
password
string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%...

Responses

Request samples

Content type
application/json
{
  • "username": "/regex/",
  • "email": "/regex/",
  • "phone": "/regex/",
  • "connectorId": "string",
  • "password": "/regex/"
}

/api/interaction/profile

Request Body schema: application/json
username
string <regex> /^[A-Z_a-z]\w*$/
email
string <regex> /^\S+@\S+\.\S+$/
phone
string <regex> /^\d+$/
connectorId
string
password
string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%...

Responses

Request samples

Content type
application/json
{
  • "username": "/regex/",
  • "email": "/regex/",
  • "phone": "/regex/",
  • "connectorId": "string",
  • "password": "/regex/"
}

/api/interaction/profile

Responses

/api/interaction/submit

Responses

/api/interaction/verification/social-authorization-uri

Request Body schema: application/json
connectorId
required
string
state
required
string
redirectUri
required
object

Validator function

Responses

Request samples

Content type
application/json
{
  • "connectorId": "string",
  • "state": "string",
  • "redirectUri": { }
}

/api/interaction/verification/verification-code

Request Body schema: application/json
One of
email
required
string <regex> /^\S+@\S+\.\S+$/

Responses

Request samples

Content type
application/json
{
  • "phone": "/regex/"
}

/api/interaction/consent

Responses

Applications

/api/applications

query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/applications

Request Body schema: application/json
tenantId
string <= 21 characters
name
required
string [ 1 .. 256 ] characters
secret
string [ 1 .. 64 ] characters
description
string or null
type
required
string
Enum: "Native" "SPA" "Traditional" "MachineToMachine"
object
object

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "secret": "string",
  • "description": "string",
  • "type": "Native",
  • "oidcClientMetadata": {
    },
  • "customClientMetadata": {
    }
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "secret": "string",
  • "description": "string",
  • "type": "Native",
  • "oidcClientMetadata": {
    },
  • "customClientMetadata": {
    },
  • "createdAt": 0
}

/api/applications/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "secret": "string",
  • "description": "string",
  • "type": "Native",
  • "oidcClientMetadata": {
    },
  • "customClientMetadata": {
    },
  • "createdAt": 0,
  • "isAdmin": true
}

/api/applications/:id

path Parameters
id
required
string non-empty
Request Body schema: application/json
tenantId
string <= 21 characters
name
string [ 1 .. 256 ] characters
secret
string [ 1 .. 64 ] characters
description
string or null
type
string
Enum: "Native" "SPA" "Traditional" "MachineToMachine"
object
object
isAdmin
boolean

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "secret": "string",
  • "description": "string",
  • "type": "Native",
  • "oidcClientMetadata": {
    },
  • "customClientMetadata": {
    },
  • "isAdmin": true
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "secret": "string",
  • "description": "string",
  • "type": "Native",
  • "oidcClientMetadata": {
    },
  • "customClientMetadata": {
    },
  • "createdAt": 0
}

/api/applications/:id

path Parameters
id
required
string non-empty

Responses

Configs

/api/configs/admin-console

Responses

Response samples

Content type
application/json
{
  • "livePreviewChecked": true,
  • "applicationCreated": true,
  • "signInExperienceCustomized": true,
  • "passwordlessConfigured": true,
  • "communityChecked": true,
  • "furtherReadingsChecked": true,
  • "roleCreated": true,
  • "m2mApplicationCreated": true
}

/api/configs/admin-console

Request Body schema: application/json
livePreviewChecked
boolean
applicationCreated
boolean
signInExperienceCustomized
boolean
passwordlessConfigured
boolean
communityChecked
boolean
furtherReadingsChecked
boolean
roleCreated
boolean
m2mApplicationCreated
boolean

Responses

Request samples

Content type
application/json
{
  • "livePreviewChecked": true,
  • "applicationCreated": true,
  • "signInExperienceCustomized": true,
  • "passwordlessConfigured": true,
  • "communityChecked": true,
  • "furtherReadingsChecked": true,
  • "roleCreated": true,
  • "m2mApplicationCreated": true
}

Response samples

Content type
application/json
{
  • "livePreviewChecked": true,
  • "applicationCreated": true,
  • "signInExperienceCustomized": true,
  • "passwordlessConfigured": true,
  • "communityChecked": true,
  • "furtherReadingsChecked": true,
  • "roleCreated": true,
  • "m2mApplicationCreated": true
}

Connectors

/api/connectors

Request Body schema: application/json
config
object

arbitrary

connectorId
required
string [ 1 .. 128 ] characters
object
syncProfile
boolean
id
string [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "connectorId": "string",
  • "metadata": {
    },
  • "syncProfile": true,
  • "id": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "syncProfile": true,
  • "config": { },
  • "metadata": {
    },
  • "connectorId": "string",
  • "target": "string",
  • "platform": "Native",
  • "name": { },
  • "logo": "string",
  • "logoDark": "string",
  • "description": { },
  • "isStandard": true,
  • "readme": "string",
  • "configTemplate": "string",
  • "formItems": [
    ],
  • "type": "Email",
  • "isDemo": true
}

/api/connectors

query Parameters
target
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/connectors/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "syncProfile": true,
  • "config": { },
  • "metadata": {
    },
  • "connectorId": "string",
  • "target": "string",
  • "platform": "Native",
  • "name": { },
  • "logo": "string",
  • "logoDark": "string",
  • "description": { },
  • "isStandard": true,
  • "readme": "string",
  • "configTemplate": "string",
  • "formItems": [
    ],
  • "type": "Email",
  • "isDemo": true
}

/api/connectors/:id

path Parameters
id
required
string non-empty
Request Body schema: application/json
config
object

arbitrary

object
syncProfile
boolean

Responses

Request samples

Content type
application/json
{
  • "config": { },
  • "metadata": {
    },
  • "syncProfile": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "syncProfile": true,
  • "config": { },
  • "metadata": {
    },
  • "connectorId": "string",
  • "target": "string",
  • "platform": "Native",
  • "name": { },
  • "logo": "string",
  • "logoDark": "string",
  • "description": { },
  • "isStandard": true,
  • "readme": "string",
  • "configTemplate": "string",
  • "formItems": [
    ],
  • "type": "Email",
  • "isDemo": true
}

/api/connectors/:id

path Parameters
id
required
string non-empty

Responses

/api/connectors/:factoryId/test

path Parameters
factoryId
required
string non-empty
Request Body schema: application/json
phone
string <regex> /^\d+$/
email
string <regex> /^\S+@\S+\.\S+$/
config
required
object

arbitrary

Responses

Request samples

Content type
application/json
{
  • "phone": "/regex/",
  • "email": "/regex/",
  • "config": { }
}

/api/connectors/:connectorId/authorization-uri

path Parameters
connectorId
required
string non-empty
Request Body schema: application/json
state
required
string
redirectUri
required
string

Responses

Request samples

Content type
application/json
{
  • "state": "string",
  • "redirectUri": "string"
}

Response samples

Content type
application/json
{
  • "redirectTo": "string"
}

Connector Factories

/api/connector-factories

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/connector-factories/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "type": "Email",
  • "isDemo": true,
  • "id": "string",
  • "target": "string",
  • "platform": "Native",
  • "name": { },
  • "logo": "string",
  • "logoDark": "string",
  • "description": { },
  • "isStandard": true,
  • "readme": "string",
  • "configTemplate": "string",
  • "formItems": [
    ]
}

Resources

/api/resources

query Parameters
includeScopes
string
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/resources

Request Body schema: application/json
tenantId
string <= 21 characters
name
required
string non-empty
indicator
required
string non-empty
accessTokenTtl
number

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "indicator": "string",
  • "accessTokenTtl": 0
}

/api/resources/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "indicator": "string",
  • "isDefault": true,
  • "accessTokenTtl": 0
}

/api/resources/:id

path Parameters
id
required
string non-empty
Request Body schema: application/json
tenantId
string <= 21 characters
name
string non-empty
accessTokenTtl
number

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "accessTokenTtl": 0
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "indicator": "string",
  • "isDefault": true,
  • "accessTokenTtl": 0
}

/api/resources/:id

path Parameters
id
required
string non-empty

Responses

/api/resources/:id/is-default

path Parameters
id
required
string non-empty
Request Body schema: application/json
isDefault
required
boolean

Responses

Request samples

Content type
application/json
{
  • "isDefault": true
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "indicator": "string",
  • "isDefault": true,
  • "accessTokenTtl": 0
}

/api/resources/:resourceId/scopes

path Parameters
resourceId
required
string non-empty
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/resources/:resourceId/scopes

path Parameters
resourceId
required
string non-empty
Request Body schema: application/json
name
required
string [ 1 .. 256 ] characters
description
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

/api/resources/:resourceId/scopes/:scopeId

path Parameters
resourceId
required
string non-empty
scopeId
required
string non-empty
Request Body schema: application/json
name
string [ 1 .. 256 ] characters
description
string non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "resourceId": "string",
  • "name": "string",
  • "description": "string",
  • "createdAt": 0
}

/api/resources/:resourceId/scopes/:scopeId

path Parameters
resourceId
required
string non-empty
scopeId
required
string non-empty

Responses

Sign In Exp

/api/sign-in-exp

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "color": {
    },
  • "branding": {
    },
  • "languageInfo": {
    },
  • "termsOfUseUrl": "string",
  • "privacyPolicyUrl": "string",
  • "signIn": {
    },
  • "signUp": {
    },
  • "socialSignInConnectorTargets": [
    ],
  • "signInMode": "SignIn",
  • "customCss": "string",
  • "customContent": {
    }
}

/api/sign-in-exp

query Parameters
removeUnusedDemoSocialConnector
string
Request Body schema: application/json
tenantId
string <= 21 characters
object
object
object
object
object
socialSignInConnectorTargets
Array of strings
signInMode
string
Enum: "SignIn" "Register" "SignInAndRegister"
customCss
string or null
object
(string or null) or string
(string or null) or string

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "color": {
    },
  • "branding": {
    },
  • "languageInfo": {
    },
  • "signIn": {
    },
  • "signUp": {
    },
  • "socialSignInConnectorTargets": [
    ],
  • "signInMode": "SignIn",
  • "customCss": "string",
  • "customContent": {
    },
  • "termsOfUseUrl": "string",
  • "privacyPolicyUrl": "string"
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "color": {
    },
  • "branding": {
    },
  • "languageInfo": {
    },
  • "termsOfUseUrl": "string",
  • "privacyPolicyUrl": "string",
  • "signIn": {
    },
  • "signUp": {
    },
  • "socialSignInConnectorTargets": [
    ],
  • "signInMode": "SignIn",
  • "customCss": "string",
  • "customContent": {
    }
}

Users

/api/users/:userId

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

/api/users/:userId

path Parameters
userId
required
string
Request Body schema: application/json
(string or null) or (string or null)
(string or null) or (string or null)
(string or null) or (string or null)
(string or null) or (string or null)
(string or null) or (string or null)
customData
object

arbitrary

Responses

Request samples

Content type
application/json
{
  • "username": "/regex/",
  • "primaryEmail": "/regex/",
  • "primaryPhone": "/regex/",
  • "name": "string",
  • "avatar": "string",
  • "customData": { }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

/api/users/:userId

path Parameters
userId
required
string

Responses

/api/users/:userId/custom-data

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{ }

/api/users/:userId/custom-data

path Parameters
userId
required
string
Request Body schema: application/json
customData
required
object

arbitrary

Responses

Request samples

Content type
application/json
{
  • "customData": { }
}

Response samples

Content type
application/json
{ }

/api/users

Request Body schema: application/json
primaryPhone
string <regex> /^\d+$/
primaryEmail
string <regex> /^\S+@\S+\.\S+$/
username
string <regex> /^[A-Z_a-z]\w*$/
password
string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%...
name
string

Responses

Request samples

Content type
application/json
{
  • "primaryPhone": "/regex/",
  • "primaryEmail": "/regex/",
  • "username": "/regex/",
  • "password": "/regex/",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

/api/users

query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/users/:userId/password

path Parameters
userId
required
string
Request Body schema: application/json
password
required
string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%...

Responses

Request samples

Content type
application/json
{
  • "password": "/regex/"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

/api/users/:userId/password/verify

path Parameters
userId
required
string
Request Body schema: application/json
password
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

/api/users/:userId/has-password

path Parameters
userId
required
string

Responses

Response samples

Content type
application/json
{
  • "hasPassword": true
}

/api/users/:userId/is-suspended

path Parameters
userId
required
string
Request Body schema: application/json
isSuspended
required
boolean

Responses

Request samples

Content type
application/json
{
  • "isSuspended": true
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

/api/users/:userId/roles

path Parameters
userId
required
string
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/users/:userId/roles

path Parameters
userId
required
string
Request Body schema: application/json
roleIds
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "roleIds": [
    ]
}

/api/users/:userId/roles

path Parameters
userId
required
string
Request Body schema: application/json
roleIds
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "roleIds": [
    ]
}

/api/users/:userId/roles/:roleId

path Parameters
userId
required
string
roleId
required
string

Responses

/api/users/:userId/identities

path Parameters
userId
required
string
Request Body schema: application/json
connectorId
required
string
required
object

Responses

Request samples

Content type
application/json
{
  • "connectorId": "string",
  • "connectorData": {
    }
}

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

/api/users/:userId/identities/:target

path Parameters
userId
required
string
target
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "username": "string",
  • "primaryEmail": "string",
  • "primaryPhone": "string",
  • "name": "string",
  • "avatar": "string",
  • "customData": { },
  • "identities": {
    },
  • "lastSignInAt": 0,
  • "createdAt": 0,
  • "applicationId": "string",
  • "isSuspended": true,
  • "hasPassword": true
}

Logs

/api/logs

query Parameters
userId
string
applicationId
string
logKey
string
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/logs/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "key": "string",
  • "payload": {
    },
  • "createdAt": 0
}

Roles

/api/roles

query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/roles

Request Body schema: application/json
tenantId
string <= 21 characters
name
required
string [ 1 .. 128 ] characters
description
required
string [ 1 .. 128 ] characters
scopeIds
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "description": "string",
  • "scopeIds": [
    ]
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

/api/roles/:id

path Parameters
id
required
string non-empty

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

/api/roles/:id

path Parameters
id
required
string non-empty
Request Body schema: application/json
name
string [ 1 .. 128 ] characters
description
string [ 1 .. 128 ] characters

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "description": "string"
}

/api/roles/:id

path Parameters
id
required
string non-empty

Responses

/api/roles/:id/users

path Parameters
id
required
string non-empty
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/roles/:id/users

path Parameters
id
required
string non-empty
Request Body schema: application/json
userIds
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "userIds": [
    ]
}

/api/roles/:id/users/:userId

path Parameters
id
required
string non-empty
userId
required
string non-empty

Responses

/api/roles/:id/scopes

path Parameters
id
required
string non-empty
query Parameters
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/roles/:id/scopes

path Parameters
id
required
string non-empty
Request Body schema: application/json
scopeIds
required
Array of strings[ items non-empty ]

Responses

Request samples

Content type
application/json
{
  • "scopeIds": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

/api/roles/:id/scopes/:scopeId

path Parameters
id
required
string non-empty
scopeId
required
string non-empty

Responses

Dashboard

/api/dashboard/users/total

Responses

Response samples

Content type
application/json
{
  • "totalUserCount": 0
}

/api/dashboard/users/new

Responses

Response samples

Content type
application/json
{
  • "today": {
    },
  • "last7Days": {
    }
}

/api/dashboard/users/active

query Parameters
date
string <regex> /^\d{4}(-\d{2}){2}/

Responses

Response samples

Content type
application/json
{
  • "dauCurve": [
    ],
  • "dau": {
    },
  • "wau": {
    },
  • "mau": {
    }
}

Custom Phrases

/api/custom-phrases

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/custom-phrases/:languageTag

path Parameters
languageTag
required
string
Enum: "af-ZA" "am-ET" "ar-AR" "as-IN" "az-AZ" "be-BY" "bg-BG" "bn-IN" "br-FR" "bs-BA" "ca-ES" "cb-IQ" "co-FR" "cs-CZ" "cx-PH" "cy-GB" "da-DK" "de" "de-DE" "el-GR" "en" "en-GB" "en-US" "eo-EO" "es" "es-ES" "es-419" "et-EE" "eu-ES" "fa-IR" "ff-NG" "fi-FI" "fo-FO" "fr" "fr-CA" "fr-FR" "fy-NL" "ga-IE" "gl-ES" "gn-PY" "gu-IN" "ha-NG" "he-IL" "hi-IN" "hr-HR" "ht-HT" "hu-HU" "hy-AM" "id-ID" "ik-US" "is-IS" "it" "it-IT" "iu-CA" "ja" "ja-JP" "ja-KS" "jv-ID" "ka-GE" "kk-KZ" "km-KH" "kn-IN" "ko" "ko-KR" "ku-TR" "ky-KG" "lo-LA" "lt-LT" "lv-LV" "mg-MG" "mk-MK" "ml-IN" "mn-MN" "mr-IN" "ms-MY" "mt-MT" "my-MM" "nb-NO" "ne-NP" "nl-BE" "nl-NL" "nn-NO" "or-IN" "pa-IN" "pl-PL" "ps-AF" "pt" "pt-BR" "pt-PT" "ro-RO" "ru" "ru-RU" "rw-RW" "sc-IT" "si-LK" "sk-SK" "sl-SI" "sn-ZW" "sq-AL" "sr-RS" "sv-SE" "sw-KE" "sy-SY" "sz-PL" "ta-IN" "te-IN" "tg-TJ" "th-TH" "tl-PH" "tr" "tr-TR" "tt-RU" "tz-MA" "uk-UA" "ur-PK" "uz-UZ" "vi-VN" "zh" "zh-CN" "zh-HK" "zh-MO" "zh-TW" "zz-TR"

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "languageTag": "string",
  • "translation": {
    }
}

/api/custom-phrases/:languageTag

path Parameters
languageTag
required
string
Enum: "af-ZA" "am-ET" "ar-AR" "as-IN" "az-AZ" "be-BY" "bg-BG" "bn-IN" "br-FR" "bs-BA" "ca-ES" "cb-IQ" "co-FR" "cs-CZ" "cx-PH" "cy-GB" "da-DK" "de" "de-DE" "el-GR" "en" "en-GB" "en-US" "eo-EO" "es" "es-ES" "es-419" "et-EE" "eu-ES" "fa-IR" "ff-NG" "fi-FI" "fo-FO" "fr" "fr-CA" "fr-FR" "fy-NL" "ga-IE" "gl-ES" "gn-PY" "gu-IN" "ha-NG" "he-IL" "hi-IN" "hr-HR" "ht-HT" "hu-HU" "hy-AM" "id-ID" "ik-US" "is-IS" "it" "it-IT" "iu-CA" "ja" "ja-JP" "ja-KS" "jv-ID" "ka-GE" "kk-KZ" "km-KH" "kn-IN" "ko" "ko-KR" "ku-TR" "ky-KG" "lo-LA" "lt-LT" "lv-LV" "mg-MG" "mk-MK" "ml-IN" "mn-MN" "mr-IN" "ms-MY" "mt-MT" "my-MM" "nb-NO" "ne-NP" "nl-BE" "nl-NL" "nn-NO" "or-IN" "pa-IN" "pl-PL" "ps-AF" "pt" "pt-BR" "pt-PT" "ro-RO" "ru" "ru-RU" "rw-RW" "sc-IT" "si-LK" "sk-SK" "sl-SI" "sn-ZW" "sq-AL" "sr-RS" "sv-SE" "sw-KE" "sy-SY" "sz-PL" "ta-IN" "te-IN" "tg-TJ" "th-TH" "tl-PH" "tr" "tr-TR" "tt-RU" "tz-MA" "uk-UA" "ur-PK" "uz-UZ" "vi-VN" "zh" "zh-CN" "zh-HK" "zh-MO" "zh-TW" "zz-TR"
Request Body schema: application/json
string or Translation (any) (Translation)
One of
string

Responses

Request samples

Content type
application/json
{
  • "input": {
    },
  • "action": {
    }
}

/api/custom-phrases/:languageTag

path Parameters
languageTag
required
string
Enum: "af-ZA" "am-ET" "ar-AR" "as-IN" "az-AZ" "be-BY" "bg-BG" "bn-IN" "br-FR" "bs-BA" "ca-ES" "cb-IQ" "co-FR" "cs-CZ" "cx-PH" "cy-GB" "da-DK" "de" "de-DE" "el-GR" "en" "en-GB" "en-US" "eo-EO" "es" "es-ES" "es-419" "et-EE" "eu-ES" "fa-IR" "ff-NG" "fi-FI" "fo-FO" "fr" "fr-CA" "fr-FR" "fy-NL" "ga-IE" "gl-ES" "gn-PY" "gu-IN" "ha-NG" "he-IL" "hi-IN" "hr-HR" "ht-HT" "hu-HU" "hy-AM" "id-ID" "ik-US" "is-IS" "it" "it-IT" "iu-CA" "ja" "ja-JP" "ja-KS" "jv-ID" "ka-GE" "kk-KZ" "km-KH" "kn-IN" "ko" "ko-KR" "ku-TR" "ky-KG" "lo-LA" "lt-LT" "lv-LV" "mg-MG" "mk-MK" "ml-IN" "mn-MN" "mr-IN" "ms-MY" "mt-MT" "my-MM" "nb-NO" "ne-NP" "nl-BE" "nl-NL" "nn-NO" "or-IN" "pa-IN" "pl-PL" "ps-AF" "pt" "pt-BR" "pt-PT" "ro-RO" "ru" "ru-RU" "rw-RW" "sc-IT" "si-LK" "sk-SK" "sl-SI" "sn-ZW" "sq-AL" "sr-RS" "sv-SE" "sw-KE" "sy-SY" "sz-PL" "ta-IN" "te-IN" "tg-TJ" "th-TH" "tl-PH" "tr" "tr-TR" "tt-RU" "tz-MA" "uk-UA" "ur-PK" "uz-UZ" "vi-VN" "zh" "zh-CN" "zh-HK" "zh-MO" "zh-TW" "zz-TR"

Responses

Hooks

/api/hooks

query Parameters
includeExecutionStats
string
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/hooks

Request Body schema: application/json
tenantId
string <= 21 characters
name
string [ 1 .. 256 ] characters
event
string or null
Enum: "PostRegister" "PostSignIn" "PostResetPassword"
events
Array of strings
Items Enum: "PostRegister" "PostSignIn" "PostResetPassword"
required
object
enabled
boolean
createdAt
number

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "event": "PostRegister",
  • "events": [
    ],
  • "config": {
    },
  • "enabled": true,
  • "createdAt": 0
}

/api/hooks/:id

path Parameters
id
required
string
query Parameters
includeExecutionStats
string

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "event": "PostRegister",
  • "events": [
    ],
  • "config": {
    },
  • "signingKey": "string",
  • "enabled": true,
  • "createdAt": 0,
  • "executionStats": {
    }
}

/api/hooks/:id

path Parameters
id
required
string
Request Body schema: application/json
tenantId
string <= 21 characters
name
string [ 1 .. 256 ] characters
event
string or null
Enum: "PostRegister" "PostSignIn" "PostResetPassword"
events
Array of strings
Items Enum: "PostRegister" "PostSignIn" "PostResetPassword"
object
enabled
boolean
createdAt
number

Responses

Request samples

Content type
application/json
{
  • "tenantId": "string",
  • "name": "string",
  • "event": "PostRegister",
  • "events": [
    ],
  • "config": {
    },
  • "enabled": true,
  • "createdAt": 0
}

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "event": "PostRegister",
  • "events": [
    ],
  • "config": {
    },
  • "signingKey": "string",
  • "enabled": true,
  • "createdAt": 0
}

/api/hooks/:id

path Parameters
id
required
string

Responses

/api/hooks/:id/recent-logs

path Parameters
id
required
string
query Parameters
logKey
string
page
integer >= 1
Default: 1
page_size
integer >= 1
Default: 20

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/hooks/:id/test

path Parameters
id
required
string
Request Body schema: application/json
events
required
Array of strings
Items Enum: "PostRegister" "PostSignIn" "PostResetPassword"
required
object

Responses

Request samples

Content type
application/json
{
  • "events": [
    ],
  • "config": {
    }
}

/api/hooks/:id/signing-key

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "name": "string",
  • "event": "PostRegister",
  • "events": [
    ],
  • "config": {
    },
  • "signingKey": "string",
  • "enabled": true,
  • "createdAt": 0
}

Verification Codes

/api/verification-codes

Request Body schema: application/json
One of
email
required
string <regex> /^\S+@\S+\.\S+$/

Responses

Request samples

Content type
application/json
{
  • "phone": "/regex/"
}

/api/verification-codes/verify

Request Body schema: application/json
One of
email
required
string <regex> /^\S+@\S+\.\S+$/
verificationCode
required
string non-empty

Responses

Request samples

Content type
application/json
{
  • "phone": "/regex/",
  • "verificationCode": "string"
}

User Assets

/api/user-assets/service-status

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "allowUploadMimeTypes": [
    ],
  • "maxUploadFileSize": 0
}

/api/user-assets

Responses

Response samples

Content type
application/json
{
  • "url": "string"
}

Domains

/api/domains

Responses

Response samples

Content type
application/json
[
  • {
    }
]

/api/domains

Request Body schema: application/json
domain
required
string [ 1 .. 256 ] characters

Responses

Request samples

Content type
application/json
{
  • "domain": "string"
}

/api/domains/:id

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "domain": "string",
  • "status": "string",
  • "errorMessage": "string",
  • "dnsRecords": [
    ]
}

/api/domains/:id

path Parameters
id
required
string

Responses

.well-known

/api/.well-known/sign-in-exp

Responses

Response samples

Content type
application/json
{
  • "tenantId": "string",
  • "id": "string",
  • "color": {
    },
  • "branding": {
    },
  • "languageInfo": {
    },
  • "termsOfUseUrl": "string",
  • "privacyPolicyUrl": "string",
  • "signIn": {
    },
  • "signUp": {
    },
  • "socialSignInConnectorTargets": [
    ],
  • "signInMode": "SignIn",
  • "customCss": "string",
  • "customContent": {
    },
  • "socialConnectors": [
    ],
  • "forgotPassword": {
    }
}

/api/.well-known/phrases

query Parameters
lng
string

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Status

/api/status

Responses

Authn

/api/authn/hasura

query Parameters
resource
required
string non-empty
unauthorizedRole
string

Responses

Response samples

Content type
application/json
{
  • "X-Hasura-User-Id": "string",
  • "X-Hasura-Role": "string"
}

/api/authn/saml/:connectorId

path Parameters
connectorId
required
string non-empty
Request Body schema: application/json
object

arbitrary

Responses

Request samples

Content type
application/json
{ }

Swagger.json

/api/swagger.json

Responses