Key Rotation API

Version: v1

Application

Add a new client secret to selected application.

POST/api/tenants/{tenant}/applications/{clientId}/secrets

Example Request

Parameters

Name Description

Name	Description
`tenant`* required string (path)
`clientId`* required string (path)
`expirationDate` string (body)

tenant* required

string

(path)

clientId* required

string

(path)

expirationDate

string

(body)

Responses

200

{
   "displayName": null,
   "clientId": null,
   "clientSecret": null,
   "theme": null,
   "redirectUris": null,
   "postLogoutRedirectUris": null,
   "consentType": null,
   "type": null,
   "grantTypes": null,
   "endpoints": null,
   "scopes": null,
   "homepageUrl": null,
   "sampleHomepageUrl": null,
   "allowUnregisteredUsersToSignIn": false,
   "hideTenantDisplayNameDuringLogIn": false,
   "allowRegister": false,
   "disableLoginAlerts": false,
   "appSwitcherProductId": null,
   "additionalLinks": null,
   "tenant": null,
   "definedRoles": null,
   "roles": null,
   "tenants": null
}

Name	Type	Description	Format
displayName	string
clientId	string
clientSecret	string
theme	string
redirectUris	array
postLogoutRedirectUris	array
consentType	string
type	string
grantTypes	array
endpoints	array
scopes	array
homepageUrl	string
sampleHomepageUrl	string
allowUnregisteredUsersToSignIn	boolean
hideTenantDisplayNameDuringLogIn	boolean
allowRegister	boolean
disableLoginAlerts	boolean
appSwitcherProductId	string
additionalLinks	string
tenant	string
definedRoles	array
roles	array
tenants	array

400

Bad Request

{
   "type": null,
   "title": null,
   "status": null,
   "detail": null,
   "instance": null
}

Name	Type	Format
type	string
title	string
status	integer	int32
detail	string
instance	string

Get the ClientSecrets that belongs to an application.

GET/api/tenants/{tenant}/applications/{clientId}/secrets

Parameters

Name Description

Name	Description
`tenant`* required string (path)
`clientId`* required string (path)

tenant* required

string

(path)

clientId* required

string

(path)

Responses

200

{
   "clientSecretId": "",
   "clientSecretExpirationDate": null,
   "deleted": false
}

Name	Type	Format
clientSecretId	string	uuid
clientSecretExpirationDate	string	date-time
deleted	boolean

403

Forbidden

{
   "type": null,
   "identifier": "",
   "message": null,
   "responseCode": null,
   "errors": null
}

Name	Type	Format
type	string
identifier	string	uuid
message	string
responseCode	string
errors	array

Soft-deletes the selected ClientSecret

DELETE/api/tenants/{tenant}/applications/{clientId}/secrets/{id}

Parameters

Name Description

Name	Description
`tenant`* required string (path)
`clientId`* required string (path)
`id`* required string (path)

tenant* required

string

(path)

clientId* required

string

(path)

id* required

string

(path)

Responses

200

{
   "displayName": null,
   "clientId": null,
   "clientSecret": null,
   "theme": null,
   "redirectUris": null,
   "postLogoutRedirectUris": null,
   "consentType": null,
   "type": null,
   "grantTypes": null,
   "endpoints": null,
   "scopes": null,
   "homepageUrl": null,
   "sampleHomepageUrl": null,
   "allowUnregisteredUsersToSignIn": false,
   "hideTenantDisplayNameDuringLogIn": false,
   "allowRegister": false,
   "disableLoginAlerts": false,
   "appSwitcherProductId": null,
   "additionalLinks": null,
   "tenant": null,
   "definedRoles": null,
   "roles": null,
   "tenants": null
}

Name	Type	Description	Format
displayName	string
clientId	string
clientSecret	string
theme	string
redirectUris	array
postLogoutRedirectUris	array
consentType	string
type	string
grantTypes	array
endpoints	array
scopes	array
homepageUrl	string
sampleHomepageUrl	string
allowUnregisteredUsersToSignIn	boolean
hideTenantDisplayNameDuringLogIn	boolean
allowRegister	boolean
disableLoginAlerts	boolean
appSwitcherProductId	string
additionalLinks	string
tenant	string
definedRoles	array
roles	array
tenants	array

400

Bad Request

{
   "type": null,
   "title": null,
   "status": null,
   "detail": null,
   "instance": null
}

Name	Type	Format
type	string
title	string
status	integer	int32
detail	string
instance	string

NoAccessRedirect

GET/no-access-callback

Parameters

Name Description

Name	Description
`state` string (query)

state

string

(query)

Responses

200

OpDashboard

GET/_/op-dashboard

Parameters

Name	Description

Responses

200

ProfileRedirect

GET/profile

Parameters

Name	Description
`tenant` string (query)
`client_id` string (query)
`redirect_uri` string (query)
`state` string (query)