Regenerate Emergency Client

Regenerate Emergency Client
Regenerate Emergency Client token secret

Regenerates the token secret for an existing Emergency Client. The new secret is returned and should be stored securely.

Request
URI
POST
https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/emergency-clients/{clientId}/regenerate
COPY
Path Parameters
string
ssoRealmId
Required

SSO Realm identifier

string
clientId
Required

Emergency Client ID

Authentication
This operation uses the following authentication methods.
Responses
200

Emergency Client with regenerated token details

Returns EmergencyClient of type(s) application/json 
"{\n  \"clientId\" : \"emergency-client-id\",\n  \"clientName\" : \"Emergency Access Client\",\n  \"clientDescription\" : \"API client for emergency access purposes\",\n  \"accessTokenTtl\" : 259200,\n  \"accessTokenExpirationDate\" : 1750526688158,\n  \"accessTokenStatus\" : \"ACTIVE\",\n  \"accessToken\" : \"eyJzdWIiOiIxM\",\n  \"tokenEndpointUrl\" : \"https://host.com/acs/t/CUSTOMER/token\",\n  \"oidcIssuerUrl\" : \"https://host.com/acs/t/CUSTOMER\"\n}"
string
accessToken
Optional

Bearer access token string

integer As int64 As int64
accessTokenExpirationDate
Optional

The date on which the access token for this emergency client expires

string
accessTokenStatus
Optional

Active / expired status for tokens generated for emergency clients

Possible values are : ACTIVE, EXPIRED, UNKNOWN,
integer As int32 As int32
accessTokenTtl
Required

Time-To-Live lifespan in minutes of the access token for this emergency client

string
clientDescription
Optional

Description for the emergency client

string
clientId
Required
Constraints: minLength: 1

Unique string that is used as the principal for this emergency client

string
clientName
Required
Constraints: minLength: 1

Friendly name for the emergency client

string
oidcIssuerUrl
Optional

The OIDC issuer URL of the identity broker that generated this emergency client

array of object
roles
Optional

Roles assigned to this client

string
tokenEndpointUrl
Optional

The token endpoint URL of the identity broker that generated this emergency client


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/emergency-clients/{clientId}/regenerate
On This Page
Iam Apis Operations
GET
Get Eligible Components
DELETE
Delete Iam Component Auth Source
POST
Create Iam Component Auth Source
POST
Get Iam Component Auth Sources
GET
Get Component Roles
POST
Provision Component Role
PUT
Update Component Role
GET
Get Component Role Summaries
DELETE
Delete Component Role
GET
Get Component Role
POST
Trigger Drift Check
POST
Retry Apply For Role
GET
Get Component Role Definitions
POST
Configure IDP
PUT
Update IDP Configuration
DELETE
Delete IDP Configuration
GET
Get IDP Configuration
GET
Get Scim Sync Client Info
POST
Generate Scim Sync Client
GET
Get Ldap Directories
POST
Lookup Ldap Groups
POST
Execute Ldap Sync
GET
Get Ldap Sync Logs
GET
Get Ldap Sync Log By Id
GET
Get Ldap Sync Profile
PUT
Update Ldap Sync Profile
POST
Lookup Ldap Users
GET
Get VCF Roles Paginated
POST
Create Role
PUT
Update Role Definition
DELETE
Delete Role
GET
Get Role
POST
Validate Saml Metadata
GET
Get Iam Settings
PUT
Update Iam Settings
GET
Get Sso Realm List
POST
Create Sso Realm
DELETE
Delete Sso Realm
GET
Get Sso Realm
PATCH
Update Api Client
POST
Create Api Client
POST
Query Api Clients
DELETE
Delete Api Client
GET
Get Api Client
PATCH
Update Api Token
POST
Generate Api Token
POST
Query Api Tokens
DELETE
Delete Api Token
GET
Get Api Token
POST
Re Generate Api Token
GET
List Emergency Clients
POST
Create Emergency Client
DELETE
Delete Emergency Client
GET
Get Emergency Client
POST
Regenerate Emergency Client
POST
Get Groups List
POST
Get Group Members List
GET
List O Auth Apps
POST
Create O Auth App
PUT
Update O Auth App
DELETE
Delete O Auth App
GET
Get O Auth App
POST
Rotate O Auth App Secret
DELETE
Delete Role Assignments
GET
Get Role Assignment
PUT
Update Role Assignment
POST
Get Users List
GET
Get Iam Task Details
GET
Get Eligible Vidbs
PATCH
Update Vidb Metadata