Create O Auth App

Create new OAuth App in SSO Realm

Creates a new OAuth App instance in the specified SSO Realm for OAuth-based authentication. This is needed for external integrations in the SSO Realm

Request

URI

POST

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

COPY

Path Parameters

string

ssoRealmId

Required

SSO Realm identifier

Request Body

OAuth App object instance

OAuthApp of type(s) application/json

Required

Show optional properties

{
    "clientName": "string"
}

"{\n  \"clientName\" : \"client1\",\n  \"redirectUrls\" : [ \"https://redirecturl1\", \"https://redirecturl2\" ],\n  \"logoutUrls\" : [ \"https://logouturl1\", \"https://logouturl2\" ]\n}"

string

clientId

Optional

Client Id

string

clientName

Required

Client Name

string

clientSecret

Optional

Client Secret

integer As int64 As int64

createdAt

Optional

Created timestamp

string As uuid As uuid

Optional

unique identifier for the object

string

issuerUrl

Optional

Identity Broker issuer URL

array of string

logoutUrls

Optional

Logout URL List

array of string

redirectUrls

Optional

Redirect URL List

string As uuid As uuid

ssoRealmId

Optional

Sso Realm Id

integer As int64 As int64

updatedAt

Optional

Updated timestamp

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

OAuth App instance

Returns OAuthApp of type(s) application/json

"{\n  \"id\" : \"0f8f1224-814a-4e15-9a88-3036aece38a4\",\n  \"ssoRealmId\" : \"0f8f1224-814a-4e15-9a88-3036aece38a6\",\n  \"clientId\" : \"clientId\",\n  \"clientSecret\" : \"bXbqiidM46zXN8N7ZZYSs9D5NsMxbUhN\",\n  \"clientName\" : \"client1\",\n  \"redirectUrls\" : [ \"https://redirecturl1\", \"https://redirecturl2\" ],\n  \"logoutUrls\" : [ \"https://logouturl1\", \"https://logouturl2\" ]\n}"

string

clientId

Optional

Client Id

string

clientName

Required

Client Name

string

clientSecret

Optional

Client Secret

integer As int64 As int64

createdAt

Optional

Created timestamp

string As uuid As uuid

Optional

unique identifier for the object

string

issuerUrl

Optional

Identity Broker issuer URL

array of string

logoutUrls

Optional

Logout URL List

array of string

redirectUrls

Optional

Redirect URL List

string As uuid As uuid

ssoRealmId

Optional

Sso Realm Id

integer As int64 As int64

updatedAt

Optional

Updated timestamp

Code Samples

COPY

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

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

201 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE