Authenticator 5 endpoints

POST /api/v1/authenticators

Create Authenticator

operationId: Authenticator_createNew

Parameters

Name In Required Type Description
activate query optional boolean —

Request Body

application/json
schema Authenticator
Property Type Required
id string optional
key string optional
name string optional
type string optional
_links object optional
status string optional
created string optional
provider object optional
└ type string optional
└ configuration object optional
└ host string optional
└ authPort integer optional
└ hostName string optional
└ secretKey string optional
└ instanceId string optional
└ sharedSecret string optional
└ integrationKey string optional
└ userNameTemplate object optional
└ template string optional
settings object optional
└ allowedFor string optional
└ compliance object optional
└ fips string optional
└ appInstanceId string optional
└ channelBinding object optional
└ style string optional
└ required string optional
└ userVerification string optional
└ tokenLifetimeInMinutes integer optional
lastUpdated string optional

Responses

200

Success
POST /api/v1/authenticators
GET /api/v1/authenticators/{authenticatorId}

Success

operationId: Authenticator_getSuccess

Parameters

Name In Required Type Description
authenticatorId path required string —

Responses

200

Success
GET /api/v1/authenticators/{authenticatorId}
PUT /api/v1/authenticators/{authenticatorId}

Updates an authenticator

operationId: Authenticator_updateAuthenticator

Parameters

Name In Required Type Description
authenticatorId path required string —

Request Body

application/json
schema Authenticator
Property Type Required
id string optional
key string optional
name string optional
type string optional
_links object optional
status string optional
created string optional
provider object optional
└ type string optional
└ configuration object optional
└ host string optional
└ authPort integer optional
└ hostName string optional
└ secretKey string optional
└ instanceId string optional
└ sharedSecret string optional
└ integrationKey string optional
└ userNameTemplate object optional
└ template string optional
settings object optional
└ allowedFor string optional
└ compliance object optional
└ fips string optional
└ appInstanceId string optional
└ channelBinding object optional
└ style string optional
└ required string optional
└ userVerification string optional
└ tokenLifetimeInMinutes integer optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authenticators/{authenticatorId}
POST /api/v1/authenticators/{authenticatorId}/lifecycle/activate

Success

operationId: Authenticator_activateLifecycleSuccess

Parameters

Name In Required Type Description
authenticatorId path required string —

Responses

200

Success
POST /api/v1/authenticators/{authenticatorId}/lifecycle/activate
POST /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate

Success

operationId: Authenticator_deactivateLifecycleSuccess

Parameters

Name In Required Type Description
authenticatorId path required string —

Responses

200

Success
POST /api/v1/authenticators/{authenticatorId}/lifecycle/deactivate

Authorizationserver 38 endpoints

GET /api/v1/authorizationServers

Success

operationId: AuthorizationServer_listServers

Parameters

Name In Required Type Description
q query optional string —
limit query optional string —
after query optional string —

Responses

200

Success
GET /api/v1/authorizationServers
POST /api/v1/authorizationServers

Success

operationId: AuthorizationServer_createNewServer

Request Body

application/json
schema AuthorizationServer
Property Type Required
id string optional
name string optional
_links object optional
issuer string optional
status string optional
created string optional
default boolean optional
audiences array optional
issuerMode string optional
credentials object optional
└ signing object optional
└ kid string optional
└ use string optional
└ lastRotated string optional
└ nextRotation string optional
└ rotationMode string optional
description string optional
lastUpdated string optional

Responses

200

Success
201

Created
POST /api/v1/authorizationServers
DELETE /api/v1/authorizationServers/{authServerId}

Success

operationId: AuthorizationServer_deleteSuccess

Parameters

Name In Required Type Description
authServerId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}
GET /api/v1/authorizationServers/{authServerId}

Success

operationId: AuthorizationServer_getById

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}
PUT /api/v1/authorizationServers/{authServerId}

Success

operationId: AuthorizationServer_updateById

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

application/json
schema AuthorizationServer
Property Type Required
id string optional
name string optional
_links object optional
issuer string optional
status string optional
created string optional
default boolean optional
audiences array optional
issuerMode string optional
credentials object optional
└ signing object optional
└ kid string optional
└ use string optional
└ lastRotated string optional
└ nextRotation string optional
└ rotationMode string optional
description string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}
GET /api/v1/authorizationServers/{authServerId}/claims

Success

operationId: AuthorizationServer_getClaims

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/claims
POST /api/v1/authorizationServers/{authServerId}/claims

Success

operationId: AuthorizationServer_createClaims

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

application/json
schema OAuth2Claim
Property Type Required
id string optional
name string optional
value string optional
_links object optional
status string optional
system boolean optional
claimType string optional
valueType string optional
conditions object optional
└ scopes array optional
group_filter_type string optional
alwaysIncludeInToken boolean optional

Responses

200

Created
201

Success
POST /api/v1/authorizationServers/{authServerId}/claims
DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Success

operationId: AuthorizationServer_deleteClaim

Parameters

Name In Required Type Description
authServerId path required string —
claimId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/claims/{claimId}
GET /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Success

operationId: AuthorizationServer_getClaims

Parameters

Name In Required Type Description
authServerId path required string —
claimId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/claims/{claimId}
PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Success

operationId: AuthorizationServer_updateClaimSuccess

Parameters

Name In Required Type Description
authServerId path required string —
claimId path required string —

Request Body

application/json
schema OAuth2Claim
Property Type Required
id string optional
name string optional
value string optional
_links object optional
status string optional
system boolean optional
claimType string optional
valueType string optional
conditions object optional
└ scopes array optional
group_filter_type string optional
alwaysIncludeInToken boolean optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}
GET /api/v1/authorizationServers/{authServerId}/clients

Success

operationId: AuthorizationServer_listClients

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/clients
DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens

Success

operationId: AuthorizationServer_deleteClientToken

Parameters

Name In Required Type Description
authServerId path required string —
clientId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens
GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens

Success

operationId: AuthorizationServer_getClientTokens

Parameters

Name In Required Type Description
authServerId path required string —
clientId path required string —
expand query optional string —
after query optional string —
limit query optional integer —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens
DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}

Success

operationId: AuthorizationServer_deleteAuthToken

Parameters

Name In Required Type Description
authServerId path required string —
clientId path required string —
tokenId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}
GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}

Success

operationId: AuthorizationServer_getClientAuthToken

Parameters

Name In Required Type Description
authServerId path required string —
clientId path required string —
tokenId path required string —
expand query optional string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/clients/{clientId}/tokens/{tokenId}
GET /api/v1/authorizationServers/{authServerId}/credentials/keys

Success

operationId: AuthorizationServer_listCredentialsKeys

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/credentials/keys
POST /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate

Success

operationId: AuthorizationServer_rotateKeyLifecycle

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

required
application/json
schema JwkUse

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/credentials/lifecycle/keyRotate
POST /api/v1/authorizationServers/{authServerId}/lifecycle/activate

Success

operationId: AuthorizationServer_activateLifecycleSuccess

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/lifecycle/activate
POST /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate

Success

operationId: AuthorizationServer_deactivateLifecycle

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/lifecycle/deactivate
GET /api/v1/authorizationServers/{authServerId}/policies

Success

operationId: AuthorizationServer_getPoliciesSuccess

Parameters

Name In Required Type Description
authServerId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/policies
POST /api/v1/authorizationServers/{authServerId}/policies

Success

operationId: AuthorizationServer_createPolicy

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

application/json
schema AuthorizationServerPolicy
Property Type Required
id string optional
name string optional
type string optional
_links object optional
status string optional
system boolean optional
created string optional
priority integer optional
_embedded object optional
conditions object optional
└ app object optional
└ exclude array optional
└ id string optional
└ name string optional
└ type string optional
└ include array optional
└ id string optional
└ name string optional
└ type string optional
└ apps object optional
└ exclude array optional
└ include array optional
└ risk object optional
└ behaviors array optional
└ users object optional
└ exclude array optional
└ include array optional
└ inactivity object optional
└ unit string optional
└ number integer optional
└ passwordExpiration object optional
└ unit string optional
└ number integer optional
└ lifecycleExpiration object optional
└ unit string optional
└ number integer optional
└ lifecycleStatus string optional
└ userLifecycleAttribute object optional
└ attributeName string optional
└ matchingValue string optional
└ device object optional
└ rooted boolean optional
└ migrated boolean optional
└ platform object optional
└ types array optional
└ supportedMDMFrameworks array optional
└ trustLevel string optional
└ groups object optional
└ exclude array optional
└ include array optional
└ people object optional
└ users object optional
└ exclude array optional
└ include array optional
└ groups object optional
└ exclude array optional
└ include array optional
└ scopes object optional
└ include array optional
└ clients object optional
└ include array optional
└ context object optional
└ expression string optional
└ network object optional
└ exclude array optional
└ include array optional
└ connection string optional
└ platform object optional
└ exclude array optional
└ os object optional
└ type string optional
└ include array optional
└ os object optional
└ type string optional
└ riskScore object optional
└ level string optional
└ grantTypes object optional
└ include array optional
└ userStatus object optional
└ value string optional
└ authContext object optional
└ authType string optional
└ authProvider object optional
└ include array optional
└ provider string optional
└ mdmEnrollment object optional
└ enrollment string optional
└ blockNonSafeAndroid boolean optional
└ userIdentifier object optional
└ type string optional
└ patterns array optional
└ value string optional
└ matchType string optional
└ attribute string optional
└ identityProvider object optional
└ idpIds array optional
└ provider string optional
└ …1 more object optional
description string optional
lastUpdated string optional

Responses

200

Success
201

Created
POST /api/v1/authorizationServers/{authServerId}/policies
DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}

Success

operationId: AuthorizationServer_deletePolicyById

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}

Success

operationId: AuthorizationServer_getPolicies

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}

Success

operationId: AuthorizationServer_updatePolicySuccess

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Request Body

application/json
schema AuthorizationServerPolicy
Property Type Required
id string optional
name string optional
type string optional
_links object optional
status string optional
system boolean optional
created string optional
priority integer optional
_embedded object optional
conditions object optional
└ app object optional
└ exclude array optional
└ id string optional
└ name string optional
└ type string optional
└ include array optional
└ id string optional
└ name string optional
└ type string optional
└ apps object optional
└ exclude array optional
└ include array optional
└ risk object optional
└ behaviors array optional
└ users object optional
└ exclude array optional
└ include array optional
└ inactivity object optional
└ unit string optional
└ number integer optional
└ passwordExpiration object optional
└ unit string optional
└ number integer optional
└ lifecycleExpiration object optional
└ unit string optional
└ number integer optional
└ lifecycleStatus string optional
└ userLifecycleAttribute object optional
└ attributeName string optional
└ matchingValue string optional
└ device object optional
└ rooted boolean optional
└ migrated boolean optional
└ platform object optional
└ types array optional
└ supportedMDMFrameworks array optional
└ trustLevel string optional
└ groups object optional
└ exclude array optional
└ include array optional
└ people object optional
└ users object optional
└ exclude array optional
└ include array optional
└ groups object optional
└ exclude array optional
└ include array optional
└ scopes object optional
└ include array optional
└ clients object optional
└ include array optional
└ context object optional
└ expression string optional
└ network object optional
└ exclude array optional
└ include array optional
└ connection string optional
└ platform object optional
└ exclude array optional
└ os object optional
└ type string optional
└ include array optional
└ os object optional
└ type string optional
└ riskScore object optional
└ level string optional
└ grantTypes object optional
└ include array optional
└ userStatus object optional
└ value string optional
└ authContext object optional
└ authType string optional
└ authProvider object optional
└ include array optional
└ provider string optional
└ mdmEnrollment object optional
└ enrollment string optional
└ blockNonSafeAndroid boolean optional
└ userIdentifier object optional
└ type string optional
└ patterns array optional
└ value string optional
└ matchType string optional
└ attribute string optional
└ identityProvider object optional
└ idpIds array optional
└ provider string optional
└ …1 more object optional
description string optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate

Activate Authorization Server Policy

operationId: AuthorizationServer_activatePolicyLifecycle

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/activate
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate

Deactivate Authorization Server Policy

operationId: AuthorizationServer_deactivatePolicyLifecycle

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/lifecycle/deactivate
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules

Enumerates all policy rules for the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_enumeratePolicyRules

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules

Creates a policy rule for the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_createPolicyRule

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —

Request Body

application/json
schema AuthorizationServerPolicyRule
Property Type Required
id string optional
name string optional
type string optional
status string optional
system boolean optional
actions object optional
└ token object optional
└ inlineHook object optional
└ id string optional
└ refreshTokenWindowMinutes integer optional
└ accessTokenLifetimeMinutes integer optional
└ refreshTokenLifetimeMinutes integer optional
created string optional
priority integer optional
conditions object optional
└ people object optional
└ users object optional
└ exclude array optional
└ include array optional
└ groups object optional
└ exclude array optional
└ include array optional
└ scopes object optional
└ include array optional
└ clients object optional
└ include array optional
└ grantTypes object optional
└ include array optional
lastUpdated string optional

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules
DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Deletes a Policy Rule defined in the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_deletePolicyRule

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —
ruleId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Returns a Policy Rule by ID that is defined in the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_getPolicyRuleById

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —
ruleId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}

Updates the configuration of the Policy Rule defined in the specified Custom Authorization Server and Policy.

operationId: AuthorizationServer_updatePolicyRuleConfiguration

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —
ruleId path required string —

Request Body

application/json
schema AuthorizationServerPolicyRule
Property Type Required
id string optional
name string optional
type string optional
status string optional
system boolean optional
actions object optional
└ token object optional
└ inlineHook object optional
└ id string optional
└ refreshTokenWindowMinutes integer optional
└ accessTokenLifetimeMinutes integer optional
└ refreshTokenLifetimeMinutes integer optional
created string optional
priority integer optional
conditions object optional
└ people object optional
└ users object optional
└ exclude array optional
└ include array optional
└ groups object optional
└ exclude array optional
└ include array optional
└ scopes object optional
└ include array optional
└ clients object optional
└ include array optional
└ grantTypes object optional
└ include array optional
lastUpdated string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate

Activate Authorization Server Policy Rule

operationId: AuthorizationServer_activatePolicyRule

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —
ruleId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/activate
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate

Deactivate Authorization Server Policy Rule

operationId: AuthorizationServer_deactivatePolicyRule

Parameters

Name In Required Type Description
authServerId path required string —
policyId path required string —
ruleId path required string —

Responses

200

Success
POST /api/v1/authorizationServers/{authServerId}/policies/{policyId}/rules/{ruleId}/lifecycle/deactivate
GET /api/v1/authorizationServers/{authServerId}/scopes

Success

operationId: AuthorizationServer_getScopes

Parameters

Name In Required Type Description
authServerId path required string —
q query optional string —
filter query optional string —
cursor query optional string —
limit query optional integer —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/scopes
POST /api/v1/authorizationServers/{authServerId}/scopes

Success

operationId: AuthorizationServer_createScope

Parameters

Name In Required Type Description
authServerId path required string —

Request Body

application/json
schema OAuth2Scope
Property Type Required
id string optional
name string optional
system boolean optional
consent string optional
default boolean optional
description string optional
displayName string optional
metadataPublish string optional

Responses

200

Success
201

Success
POST /api/v1/authorizationServers/{authServerId}/scopes
DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Success

operationId: AuthorizationServer_deleteScope

Parameters

Name In Required Type Description
authServerId path required string —
scopeId path required string —

Responses

204

No Content
DELETE /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}
GET /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Success

operationId: AuthorizationServer_getScopes

Parameters

Name In Required Type Description
authServerId path required string —
scopeId path required string —

Responses

200

Success
GET /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}
PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Success

operationId: AuthorizationServer_updateScopeSuccess

Parameters

Name In Required Type Description
authServerId path required string —
scopeId path required string —

Request Body

application/json
schema OAuth2Scope
Property Type Required
id string optional
name string optional
system boolean optional
consent string optional
default boolean optional
description string optional
displayName string optional
metadataPublish string optional

Responses

200

Success
PUT /api/v1/authorizationServers/{authServerId}/scopes/{scopeId}

Brand 7 endpoints

GET /api/v1/brands

List all the brands in your org.

operationId: Brand_getAllBrands

Responses

200

Success
GET /api/v1/brands
GET /api/v1/brands/{brandId}

Fetches a brand by brandId

operationId: Brand_getById

Parameters

Name In Required Type Description
brandId path required string —

Responses

200

Success
404

Not Found
GET /api/v1/brands/{brandId}
PUT /api/v1/brands/{brandId}

Updates a brand by brandId

operationId: Brand_updateByBrandId

Parameters

Name In Required Type Description
brandId path required string —

Request Body

required
application/json
schema Brand

Responses

200

Success
400

Bad Request
PUT /api/v1/brands/{brandId}
GET /api/v1/brands/{brandId}/templates/email

List email templates in your organization with pagination.

operationId: Brand_listEmailTemplates

Parameters

Name In Required Type Description
brandId path required string —
after query optional string

Specifies the pagination cursor for the next page of email templates.
limit query optional integer

Specifies the number of results returned (maximum 200)

Responses

200

Success
GET /api/v1/brands/{brandId}/templates/email
GET /api/v1/brands/{brandId}/templates/email/{templateName}

Fetch an email template by templateName

operationId: Brand_getEmailTemplate

Parameters

Name In Required Type Description
brandId path required string —
templateName path required string —

Responses

200

Success
GET /api/v1/brands/{brandId}/templates/email/{templateName}
DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations

Delete all customizations for an email template. Also known as “Reset to Default”.

operationId: Brand_deleteEmailTemplateCustomizations

Parameters

Name In Required Type Description
brandId path required string —
templateName path required string —

Responses

204

Success
DELETE /api/v1/brands/{brandId}/templates/email/{templateName}/customizations
GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations

List all email customizations for an email template

operationId: Brand_listEmailTemplateCustomizations

Parameters

Name In Required Type Description
brandId path required string —
templateName path required string —

Responses

200

Success
GET /api/v1/brands/{brandId}/templates/email/{templateName}/customizations
Load more endpoints