Create Api Client

Create new API Client in SSO Realm

Creates a new API Client in the specified SSO Realm for API access.

Request

URI

POST

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

COPY

Path Parameters

string

ssoRealmId

Required

SSO Realm identifier

Request Body

API Client configuration object

ApiClient of type(s) application/json

Required

Show optional properties

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

"{\n  \"clientId\" : \"api-client-id\",\n  \"clientName\" : \"Automation API Client\",\n  \"clientDescription\" : \"API Client for automation purposes\"\n}"

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

array of object

roles

Optional

Roles assigned to this API client

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

Created API Client details

Returns ApiClient of type(s) application/json

"{\n  \"clientId\" : \"api-client-id\",\n  \"clientUuid\" : \"77ca0ca8-a504-4969-aeed-4ac453c1ef61\",\n  \"clientName\" : \"Automation API Client\",\n  \"clientDescription\" : \"API Client for automation purposes\"\n}"

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

array of object

roles

Optional

Roles assigned to this API client

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"clientId":"string","clientName":"string"}' https://{api_host}/suite-api/api/fleet-management/iam/ssorealms/{ssoRealmId}/api-clients

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE