ApiClient

ApiClient
ApiClient

Client for which one or more API tokens can be created to facilitate API-based access

JSON Example
{
    "clientDescription": "string",
    "clientId": "string",
    "clientName": "string",
    "clientUuid": "string",
    "roles": [
        {
            "expiresAt": 0,
            "roleDisplayName": "string",
            "roleName": "string",
            "roleScope": {
                "resources": [
                    {
                        "id": "string",
                        "name": "string"
                    }
                ],
                "scopeType": "string",
                "ssoName": "string"
            }
        }
    ]
}
string
clientDescription
Optional

Optional description for the API client

string
clientId
Required
Constraints: minLength: 1

API client unique string that is used for the CRUD operations within identity broker single tenant

string
clientName
Required

Friendly name for the API client

string As uuid As uuid
clientUuid
Optional

API Client unique string that is used as the principal for role assignment within identity broker

roles
Optional

Roles assigned to this API client