Skip to content

Product documentation

LoginExperience

The LoginExperience resource.

LoginExperience

The LoginExperience resource.

Base URL: https://api.stg.thoryn.org

Operations

MethodPathSummaryScopes
GET/api/v1/login-experience/analytics/loginsLogin Experience Login Analyticstenant:idp.read
GET/api/v1/login-experience/brandingLogin Experience Get Brandingtenant:idp.read
PUT/api/v1/login-experience/brandingLogin Experience Put Brandingtenant:idp.write
GET/api/v1/login-experience/domainsLogin Experience List Domainstenant:idp.read
POST/api/v1/login-experience/domainsLogin Experience Register Domaintenant:idp.write
DELETE/api/v1/login-experience/domains/{domain}Login Experience Delete Domaintenant:idp.write
POST/api/v1/login-experience/domains/{domain}/verifyLogin Experience Verify Domaintenant:idp.write
GET/api/v1/login-experience/email-templates/{type}Login Experience Get Email Templatetenant:idp.read
PUT/api/v1/login-experience/email-templates/{type}Login Experience Put Email Templatetenant:idp.write
DELETE/api/v1/login-experience/email-templates/{type}Login Experience Delete Email Templatetenant:idp.write
POST/api/v1/login-experience/email-templates/{type}/test-sendLogin Experience Test Send Email Templatetenant:idp.write
GET/api/v1/login-experience/social-connectorsLogin Experience List Connectorstenant:idp.read
GET/api/v1/login-experience/social-connectors/{provider}Login Experience Get Connectortenant:idp.read
POST/api/v1/login-experience/social-connectors/{provider}Login Experience Create Connectortenant:idp.write
PATCH/api/v1/login-experience/social-connectors/{provider}Login Experience Patch Connectortenant:idp.write
DELETE/api/v1/login-experience/social-connectors/{provider}Login Experience Delete Connectortenant:idp.write

Operation details

GET /api/v1/login-experience/analytics/logins

Login Experience Login Analytics

  • Operation ID: loginExperienceLoginAnalytics
  • Required scopes: tenant:idp.read

Parameters:

NameInRequiredTypeDescription
fromquerynostring
toquerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonPutBrandingRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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/jsonRegisterLoginDomainRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
domainpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
domainpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
typepathyesstring
localequerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
typepathyesstring
localequerynostring

Request body (required): application/jsonPutEmailTemplateRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
typepathyesstring
localequerynostring
allLocalesquerynoboolean

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
typepathyesstring
localequerynostring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
providerpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
providerpathyesstring

Request body (required): application/jsonCreateSocialConnectorRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
providerpathyesstring

Request body (required): application/jsonPatchSocialConnectorRequest

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — 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:

NameInRequiredTypeDescription
providerpathyesstring

Responses:

StatusDescriptionBody
200OKobject
401Unauthorized — bearer token missing, expired, signed by an untrusted issuer, or missing the tnt tenant claim.Problem (problem+json)
403Forbidden — token lacks a required tenant:* scope, or the tnt claim does not match the tenant addressed by the request path.Problem (problem+json)