Get Emergency Client

Get Emergency Client details by ID

Retrieves complete details of a specific Emergency Client by client ID.

Request

URI

GET

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

COPY

Path Parameters

string

ssoRealmId

Required

SSO Realm identifier

string

clientId

Required

Emergency Client ID

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

200

Emergency Client 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  \"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 -H 'Authorization: <value>' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/emergency-clients/{clientId}

On This Page

Description

Request

Path Parameters

Authentication

Response

200 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE

Delete Iam Component Auth Source