Create Emergency Client

Create Emergency Client with generated token in SSO Realm

Creates an Emergency Client with an automatically generated token. Emergency clients are used for critical access scenarios.

Request

URI

POST

https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/emergency-clients

COPY

Path Parameters

string

ssoRealmId

Required

SSO Realm identifier

Request Body

Emergency Client configuration object

EmergencyClient of type(s) application/json

Required

Show optional properties

{
    "accessTokenTtl": 0,
    "clientId": "string",
    "clientName": "string"
}

"{\n  \"clientId\" : \"emergency-client-id\",\n  \"clientName\" : \"Emergency Access Client\",\n  \"clientDescription\" : \"API client for emergency access purposes\",\n  \"accessTokenTtl\" : 259200\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

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

Created Emergency Client details and its generated token

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\" : \"eyJhbGciOiJIUz\",\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>' -H 'Content-Type: application/json' -d '{"accessTokenTtl":"integer","clientId":"string","clientName":"string"}' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/emergency-clients

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE