Product documentation
LoginExperience
The LoginExperience resource.
LoginExperience
The LoginExperience resource.
Base URL: https://api.stg.thoryn.org
Operations
| Method | Path | Summary | Scopes |
|---|---|---|---|
GET | /api/v1/login-experience/analytics/logins | Login Experience Login Analytics | tenant:idp.read |
GET | /api/v1/login-experience/branding | Login Experience Get Branding | tenant:idp.read |
PUT | /api/v1/login-experience/branding | Login Experience Put Branding | tenant:idp.write |
GET | /api/v1/login-experience/domains | Login Experience List Domains | tenant:idp.read |
POST | /api/v1/login-experience/domains | Login Experience Register Domain | tenant:idp.write |
DELETE | /api/v1/login-experience/domains/{domain} | Login Experience Delete Domain | tenant:idp.write |
POST | /api/v1/login-experience/domains/{domain}/verify | Login Experience Verify Domain | tenant:idp.write |
GET | /api/v1/login-experience/email-templates/{type} | Login Experience Get Email Template | tenant:idp.read |
PUT | /api/v1/login-experience/email-templates/{type} | Login Experience Put Email Template | tenant:idp.write |
DELETE | /api/v1/login-experience/email-templates/{type} | Login Experience Delete Email Template | tenant:idp.write |
POST | /api/v1/login-experience/email-templates/{type}/test-send | Login Experience Test Send Email Template | tenant:idp.write |
GET | /api/v1/login-experience/social-connectors | Login Experience List Connectors | tenant:idp.read |
GET | /api/v1/login-experience/social-connectors/{provider} | Login Experience Get Connector | tenant:idp.read |
POST | /api/v1/login-experience/social-connectors/{provider} | Login Experience Create Connector | tenant:idp.write |
PATCH | /api/v1/login-experience/social-connectors/{provider} | Login Experience Patch Connector | tenant:idp.write |
DELETE | /api/v1/login-experience/social-connectors/{provider} | Login Experience Delete Connector | tenant:idp.write |
Operation details
GET /api/v1/login-experience/analytics/logins
Login Experience Login Analytics
- Operation ID:
loginExperienceLoginAnalytics - Required scopes:
tenant:idp.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
from | query | no | string | |
to | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/login-experience/branding
Login Experience Get Branding
- Operation ID:
loginExperienceGetBranding - Required scopes:
tenant:idp.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PUT /api/v1/login-experience/branding
Login Experience Put Branding
- Operation ID:
loginExperiencePutBranding - Required scopes:
tenant:idp.write
Request body (required): application/json → PutBrandingRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/login-experience/domains
Login Experience List Domains
- Operation ID:
loginExperienceListDomains - Required scopes:
tenant:idp.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/login-experience/domains
Login Experience Register Domain
- Operation ID:
loginExperienceRegisterDomain - Required scopes:
tenant:idp.write
Request body (required): application/json → RegisterLoginDomainRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/login-experience/domains/{domain}
Login Experience Delete Domain
- Operation ID:
loginExperienceDeleteDomain - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/login-experience/domains/{domain}/verify
Login Experience Verify Domain
- Operation ID:
loginExperienceVerifyDomain - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
domain | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/login-experience/email-templates/{type}
Login Experience Get Email Template
- Operation ID:
loginExperienceGetEmailTemplate - Required scopes:
tenant:idp.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | path | yes | string | |
locale | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PUT /api/v1/login-experience/email-templates/{type}
Login Experience Put Email Template
- Operation ID:
loginExperiencePutEmailTemplate - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | path | yes | string | |
locale | query | no | string |
Request body (required): application/json → PutEmailTemplateRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/login-experience/email-templates/{type}
Login Experience Delete Email Template
- Operation ID:
loginExperienceDeleteEmailTemplate - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | path | yes | string | |
locale | query | no | string | |
allLocales | query | no | boolean |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/login-experience/email-templates/{type}/test-send
Login Experience Test Send Email Template
- Operation ID:
loginExperienceTestSendEmailTemplate - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
type | path | yes | string | |
locale | query | no | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/login-experience/social-connectors
Login Experience List Connectors
- Operation ID:
loginExperienceListConnectors - Required scopes:
tenant:idp.read
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
GET /api/v1/login-experience/social-connectors/{provider}
Login Experience Get Connector
- Operation ID:
loginExperienceGetConnector - Required scopes:
tenant:idp.read
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
provider | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
POST /api/v1/login-experience/social-connectors/{provider}
Login Experience Create Connector
- Operation ID:
loginExperienceCreateConnector - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
provider | path | yes | string |
Request body (required): application/json → CreateSocialConnectorRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
PATCH /api/v1/login-experience/social-connectors/{provider}
Login Experience Patch Connector
- Operation ID:
loginExperiencePatchConnector - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
provider | path | yes | string |
Request body (required): application/json → PatchSocialConnectorRequest
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |
DELETE /api/v1/login-experience/social-connectors/{provider}
Login Experience Delete Connector
- Operation ID:
loginExperienceDeleteConnector - Required scopes:
tenant:idp.write
Parameters:
| Name | In | Required | Type | Description |
|---|---|---|---|---|
provider | path | yes | string |
Responses:
| Status | Description | Body |
|---|---|---|
200 | OK | object |
401 | Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim. | Problem (problem+json) |
403 | Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path. | Problem (problem+json) |