EmergencyClient

EmergencyClient
EmergencyClient

API Client with a long-lived privileged bearer access token to facilitate API-based access in emergency scenarios

JSON Example
{
    "accessToken": "string",
    "accessTokenExpirationDate": 0,
    "accessTokenStatus": "string",
    "accessTokenTtl": 0,
    "clientDescription": "string",
    "clientId": "string",
    "clientName": "string",
    "oidcIssuerUrl": "string",
    "roles": [
        {
            "expiresAt": 0,
            "roleDisplayName": "string",
            "roleName": "string",
            "roleScope": {
                "resources": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ],
                "scopeType": "string",
                "ssoName": "string"
            }
        }
    ],
    "tokenEndpointUrl": "string"
}
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 VcfRoleAssignment
roles
Optional

Roles assigned to this client

string
tokenEndpointUrl
Optional

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

Property Of
Parameter To
Returned By