Logto Core (0.1.0)
Download OpenAPI specification:Download
/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
- Payload
Content type
application/json
{- "event": "SignIn",
- "identifier": {
- "username": "string",
- "password": "string"
}, - "profile": {
- "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*$/ |
string <regex> /^\S+@\S+\.\S+$/ | |
phone | string <regex> /^\d+$/ |
connectorId | string |
password | string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%... |
Responses
Request samples
- Payload
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*$/ |
string <regex> /^\S+@\S+\.\S+$/ | |
phone | string <regex> /^\d+$/ |
connectorId | string |
password | string <regex> /^((?=.*\d)(?=.*[A-Za-z])|(?=.*\d)(?=.*[!"#$%... |
Responses
Request samples
- Payload
Content type
application/json
{- "username": "/regex/",
- "email": "/regex/",
- "phone": "/regex/",
- "connectorId": "string",
- "password": "/regex/"
}
/api/applications
query Parameters
page | integer >= 1 Default: 1 |
page_size | integer >= 1 Default: 20 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}, - "createdAt": 0
}
]
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}, - "createdAt": 0
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}, - "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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}, - "isAdmin": true
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "secret": "string",
- "description": "string",
- "type": "Native",
- "oidcClientMetadata": {
- "redirectUris": [
- { }
], - "postLogoutRedirectUris": [
- "string"
], - "logoUri": "string"
}, - "customClientMetadata": {
- "corsAllowedOrigins": [
- "string"
], - "idTokenTtl": 0,
- "refreshTokenTtl": 0,
- "tenantId": "string",
- "alwaysIssueRefreshToken": true
}, - "createdAt": 0
}
Response samples
- 200
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
- Payload
Content type
application/json
{- "livePreviewChecked": true,
- "applicationCreated": true,
- "signInExperienceCustomized": true,
- "passwordlessConfigured": true,
- "communityChecked": true,
- "furtherReadingsChecked": true,
- "roleCreated": true,
- "m2mApplicationCreated": true
}
Response samples
- 200
Content type
application/json
{- "livePreviewChecked": true,
- "applicationCreated": true,
- "signInExperienceCustomized": true,
- "passwordlessConfigured": true,
- "communityChecked": true,
- "furtherReadingsChecked": true,
- "roleCreated": true,
- "m2mApplicationCreated": true
}
/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
- Payload
Content type
application/json
{- "config": { },
- "connectorId": "string",
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "syncProfile": true,
- "id": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "syncProfile": true,
- "config": { },
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "connectorId": "string",
- "target": "string",
- "platform": "Native",
- "name": { },
- "logo": "string",
- "logoDark": "string",
- "description": { },
- "isStandard": true,
- "readme": "string",
- "configTemplate": "string",
- "formItems": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
], - "type": "Email",
- "isDemo": true
}
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "syncProfile": true,
- "config": { },
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "connectorId": "string",
- "target": "string",
- "platform": "Native",
- "name": { },
- "logo": "string",
- "logoDark": "string",
- "description": { },
- "isStandard": true,
- "readme": "string",
- "configTemplate": "string",
- "formItems": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
], - "type": "Email",
- "isDemo": true
}
]
Response samples
- 200
Content type
application/json
{- "id": "string",
- "syncProfile": true,
- "config": { },
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "connectorId": "string",
- "target": "string",
- "platform": "Native",
- "name": { },
- "logo": "string",
- "logoDark": "string",
- "description": { },
- "isStandard": true,
- "readme": "string",
- "configTemplate": "string",
- "formItems": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
], - "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
- Payload
Content type
application/json
{- "config": { },
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "syncProfile": true
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "syncProfile": true,
- "config": { },
- "metadata": {
- "target": "string",
- "name": { },
- "logo": "string",
- "logoDark": "string"
}, - "connectorId": "string",
- "target": "string",
- "platform": "Native",
- "name": { },
- "logo": "string",
- "logoDark": "string",
- "description": { },
- "isStandard": true,
- "readme": "string",
- "configTemplate": "string",
- "formItems": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
], - "type": "Email",
- "isDemo": true
}
/api/connectors/:factoryId/test
path Parameters
factoryId required | string non-empty |
Request Body schema: application/json
phone | string <regex> /^\d+$/ |
string <regex> /^\S+@\S+\.\S+$/ | |
config required | object arbitrary |
Responses
Request samples
- Payload
Content type
application/json
{- "phone": "/regex/",
- "email": "/regex/",
- "config": { }
}
Response samples
- 200
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": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
]
}
]
Response samples
- 200
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": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
]
}
/api/resources
query Parameters
includeScopes | string |
page | integer >= 1 Default: 1 |
page_size | integer >= 1 Default: 20 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "name": "string",
- "indicator": "string",
- "isDefault": true,
- "accessTokenTtl": 0,
- "scopes": [
- {
- "tenantId": "string",
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "description": "string",
- "createdAt": 0
}
]
}
]
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "indicator": "string",
- "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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "accessTokenTtl": 0
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "indicator": "string",
- "isDefault": true,
- "accessTokenTtl": 0
}
/api/resources/:id/is-default
path Parameters
id required | string non-empty |
Request Body schema: application/json
isDefault required | boolean |
Responses
Request samples
- Payload
Content type
application/json
{- "isDefault": true
}
Response samples
- 200
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
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "description": "string",
- "createdAt": 0
}
]
/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
- Payload
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
- Payload
Content type
application/json
{- "name": "string",
- "description": "string"
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "description": "string",
- "createdAt": 0
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "color": {
- "primaryColor": "/regex/",
- "isDarkModeEnabled": true,
- "darkPrimaryColor": "/regex/"
}, - "branding": {
- "logoUrl": "string",
- "darkLogoUrl": "string",
- "favicon": "string"
}, - "languageInfo": {
- "autoDetect": true,
- "fallbackLanguage": "af-ZA"
}, - "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string",
- "signIn": {
- "methods": [
- {
- "identifier": "username",
- "password": true,
- "verificationCode": true,
- "isPasswordPrimary": true
}
]
}, - "signUp": {
- "identifiers": [
- "username"
], - "password": true,
- "verify": true
}, - "socialSignInConnectorTargets": [
- "string"
], - "signInMode": "SignIn",
- "customCss": "string",
- "customContent": {
- "property1": "string",
- "property2": "string"
}
}
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "color": {
- "primaryColor": "/regex/",
- "isDarkModeEnabled": true,
- "darkPrimaryColor": "/regex/"
}, - "branding": {
- "logoUrl": "string",
- "darkLogoUrl": "string",
- "favicon": "string"
}, - "languageInfo": {
- "autoDetect": true,
- "fallbackLanguage": "af-ZA"
}, - "signIn": {
- "methods": [
- {
- "identifier": "username",
- "password": true,
- "verificationCode": true,
- "isPasswordPrimary": true
}
]
}, - "signUp": {
- "identifiers": [
- "username"
], - "password": true,
- "verify": true
}, - "socialSignInConnectorTargets": [
- "string"
], - "signInMode": "SignIn",
- "customCss": "string",
- "customContent": {
- "property1": "string",
- "property2": "string"
}, - "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string"
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "color": {
- "primaryColor": "/regex/",
- "isDarkModeEnabled": true,
- "darkPrimaryColor": "/regex/"
}, - "branding": {
- "logoUrl": "string",
- "darkLogoUrl": "string",
- "favicon": "string"
}, - "languageInfo": {
- "autoDetect": true,
- "fallbackLanguage": "af-ZA"
}, - "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string",
- "signIn": {
- "methods": [
- {
- "identifier": "username",
- "password": true,
- "verificationCode": true,
- "isPasswordPrimary": true
}
]
}, - "signUp": {
- "identifiers": [
- "username"
], - "password": true,
- "verify": true
}, - "socialSignInConnectorTargets": [
- "string"
], - "signInMode": "SignIn",
- "customCss": "string",
- "customContent": {
- "property1": "string",
- "property2": "string"
}
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "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
- Payload
Content type
application/json
{- "username": "/regex/",
- "primaryEmail": "/regex/",
- "primaryPhone": "/regex/",
- "name": "string",
- "avatar": "string",
- "customData": { }
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
/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
- Payload
Content type
application/json
{- "primaryPhone": "/regex/",
- "primaryEmail": "/regex/",
- "username": "/regex/",
- "password": "/regex/",
- "name": "string"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
]
/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
- Payload
Content type
application/json
{- "password": "/regex/"
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
/api/users/:userId/is-suspended
path Parameters
userId required | string |
Request Body schema: application/json
isSuspended required | boolean |
Responses
Request samples
- Payload
Content type
application/json
{- "isSuspended": true
}
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
/api/users/:userId/identities
path Parameters
userId required | string |
Request Body schema: application/json
connectorId required | string |
required | object |
Responses
Request samples
- Payload
Content type
application/json
{- "connectorId": "string",
- "connectorData": {
- "property1": { },
- "property2": { }
}
}
Response samples
- 200
Content type
application/json
{- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}
/api/users/:userId/identities/:target
path Parameters
userId required | string |
target required | string |
Responses
Response samples
- 200
Content type
application/json
{- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
/api/logs
query Parameters
userId | string |
applicationId | string |
logKey | string |
page | integer >= 1 Default: 1 |
page_size | integer >= 1 Default: 20 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "id": "string",
- "key": "string",
- "payload": {
- "key": "string",
- "result": "Success",
- "error": {
- "property1": { },
- "property2": { }
}, - "ip": "string",
- "userAgent": "string",
- "userId": "string",
- "applicationId": "string",
- "sessionId": "string"
}, - "createdAt": 0
}
]
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "key": "string",
- "payload": {
- "key": "string",
- "result": "Success",
- "error": {
- "property1": { },
- "property2": { }
}, - "ip": "string",
- "userAgent": "string",
- "userId": "string",
- "applicationId": "string",
- "sessionId": "string"
}, - "createdAt": 0
}
Response samples
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "name": "string",
- "description": "string",
- "usersCount": 0,
- "featuredUsers": [
- {
- "avatar": "string",
- "id": "string",
- "name": "string"
}
]
}
]
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "description": "string",
- "scopeIds": [
- "string"
]
}
Response samples
- 200
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
- Payload
Content type
application/json
{- "name": "string",
- "description": "string"
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "description": "string"
}
/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
- 200
Content type
application/json
[- {
- "id": "string",
- "username": "string",
- "primaryEmail": "string",
- "primaryPhone": "string",
- "name": "string",
- "avatar": "string",
- "customData": { },
- "identities": {
- "property1": {
- "userId": "string",
- "details": { }
}, - "property2": {
- "userId": "string",
- "details": { }
}
}, - "lastSignInAt": 0,
- "createdAt": 0,
- "applicationId": "string",
- "isSuspended": true,
- "hasPassword": true
}
]
/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
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "description": "string",
- "createdAt": 0,
- "resource": {
- "tenantId": "string",
- "id": "string",
- "name": "string",
- "indicator": "string",
- "isDefault": true,
- "accessTokenTtl": 0
}
}
]
/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
- Payload
Content type
application/json
{- "scopeIds": [
- "string"
]
}
Response samples
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "resourceId": "string",
- "name": "string",
- "description": "string",
- "createdAt": 0
}
]
/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
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "languageTag": "string",
- "translation": {
- "input": {
- "username": "Username",
- "password": "Password"
}, - "action": {
- "sign_in": "Sign In",
- "continue": "Continue"
}
}
}
/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
- Payload
Content type
application/json
{- "input": {
- "username": "Username",
- "password": "Password"
}, - "action": {
- "sign_in": "Sign In",
- "continue": "Continue"
}
}
/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
/api/hooks
query Parameters
includeExecutionStats | string |
page | integer >= 1 Default: 1 |
page_size | integer >= 1 Default: 20 |
Responses
Response samples
- 200
Content type
application/json
[- {
- "tenantId": "string",
- "id": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "signingKey": "string",
- "enabled": true,
- "createdAt": 0,
- "executionStats": {
- "successCount": 0,
- "requestCount": 0
}
}
]
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "enabled": true,
- "createdAt": 0
}
/api/hooks/:id
path Parameters
id required | string |
query Parameters
includeExecutionStats | string |
Responses
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "signingKey": "string",
- "enabled": true,
- "createdAt": 0,
- "executionStats": {
- "successCount": 0,
- "requestCount": 0
}
}
/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
- Payload
Content type
application/json
{- "tenantId": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "enabled": true,
- "createdAt": 0
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "signingKey": "string",
- "enabled": true,
- "createdAt": 0
}
/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
- 200
Content type
application/json
[- {
- "id": "string",
- "key": "string",
- "payload": {
- "key": "string",
- "result": "Success",
- "error": {
- "property1": { },
- "property2": { }
}, - "ip": "string",
- "userAgent": "string",
- "userId": "string",
- "applicationId": "string",
- "sessionId": "string"
}, - "createdAt": 0
}
]
/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
- Payload
Content type
application/json
{- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "name": "string",
- "event": "PostRegister",
- "events": [
- "PostRegister"
], - "config": {
- "url": "string",
- "headers": {
- "property1": "string",
- "property2": "string"
}, - "retries": 0
}, - "signingKey": "string",
- "enabled": true,
- "createdAt": 0
}
Response samples
- 200
Content type
application/json
{- "tenantId": "string",
- "id": "string",
- "color": {
- "primaryColor": "/regex/",
- "isDarkModeEnabled": true,
- "darkPrimaryColor": "/regex/"
}, - "branding": {
- "logoUrl": "string",
- "darkLogoUrl": "string",
- "favicon": "string"
}, - "languageInfo": {
- "autoDetect": true,
- "fallbackLanguage": "af-ZA"
}, - "termsOfUseUrl": "string",
- "privacyPolicyUrl": "string",
- "signIn": {
- "methods": [
- {
- "identifier": "username",
- "password": true,
- "verificationCode": true,
- "isPasswordPrimary": true
}
]
}, - "signUp": {
- "identifiers": [
- "username"
], - "password": true,
- "verify": true
}, - "socialSignInConnectorTargets": [
- "string"
], - "signInMode": "SignIn",
- "customCss": "string",
- "customContent": {
- "property1": "string",
- "property2": "string"
}, - "socialConnectors": [
- {
- "id": "string",
- "target": "string",
- "platform": "Native",
- "name": { },
- "logo": "string",
- "logoDark": "string",
- "description": { },
- "isStandard": true,
- "readme": "string",
- "configTemplate": "string",
- "formItems": [
- {
- "type": "string",
- "selectItems": [
- {
- "value": "string",
- "title": "string"
}
], - "key": "string",
- "label": "string",
- "placeholder": "string",
- "required": true,
- "defaultValue": { },
- "showConditions": [
- {
- "targetKey": "string",
- "expectValue": { }
}
], - "description": "string",
- "tooltip": "string",
- "isConfidential": true
}
]
}
], - "forgotPassword": {
- "phone": true,
- "email": true
}
}