Create Iam Component Auth Source

Create Iam Component Auth Source (VCF or Management Component based).

Creates Iam Component Auth Source. Can be based on a VCF Component or a Management Component type.

Request

URI

POST

https://{api_host}/suite-api/api/fleet-management/iam/components/auth-sources

COPY

Request Body

IAM Component Auth Source request payload

IamComponentAuthSource of type(s) application/json

Required

Show optional properties

{
    "authSourceType": "string",
    "ssoRealmId": "string"
}

"{\n  \"ssoRealmId\" : \"c23c6e31-4900-4e94-99f0-39f0f20308be\",\n  \"authSourceType\" : \"VCF_COMPONENT\",\n  \"vcfComponentId\" : \"a23c6e31-4900-4e94-99f0-39f0f20308be\"\n}"

string

authSourceType

Required

Auth Source Type enum

Possible values are : VCF_COMPONENT, MANAGEMENT_COMPONENT, UNKNOWN,

string

componentType

Optional

VCF Component type

Possible values are : VCENTER, NSX_MANAGER, VCF_OPERATIONS, VCF_AUTOMATION, HCX, VCF_ORCHESTRATOR, UNKNOWN,

integer As int64 As int64

createdAt

Optional

Authsource creation time

string As uuid As uuid

ssoRealmId

Required

SSO Realm identifier

string

status

Optional

Auth source configuration status

Possible values are : CONFIGURING, CONFIGURED, NOT_CONFIGURED, NOT_ELIGIBLE, MARKED_FOR_CREATION, FAILED, MARKED_FOR_DELETION, DISCOVERED, UNKNOWN,

integer As int64 As int64

updatedAt

Optional

Authsource last updated time

string As uuid As uuid

vcfComponentId

Optional

VCF component identifier (required when authSourceType is VCF_COMPONENT)

string As uuid As uuid

vcfComponentResourceId

Optional

VCF component resource ID for VCenter or NSX cluster

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

Create Auth Source result

Returns IamComponentAuthSource of type(s) application/json

{
    "authSourceType": "string",
    "componentType": "VCF_OPERATIONS",
    "createdAt": 0,
    "ssoRealmId": "string",
    "status": "string",
    "updatedAt": 0,
    "vcfComponentId": "string",
    "vcfComponentResourceId": "string"
}

string

authSourceType

Required

Auth Source Type enum

Possible values are : VCF_COMPONENT, MANAGEMENT_COMPONENT, UNKNOWN,

string

componentType

Optional

VCF Component type

Possible values are : VCENTER, NSX_MANAGER, VCF_OPERATIONS, VCF_AUTOMATION, HCX, VCF_ORCHESTRATOR, UNKNOWN,

integer As int64 As int64

createdAt

Optional

Authsource creation time

string As uuid As uuid

ssoRealmId

Required

SSO Realm identifier

string

status

Optional

Auth source configuration status

Possible values are : CONFIGURING, CONFIGURED, NOT_CONFIGURED, NOT_ELIGIBLE, MARKED_FOR_CREATION, FAILED, MARKED_FOR_DELETION, DISCOVERED, UNKNOWN,

integer As int64 As int64

updatedAt

Optional

Authsource last updated time

string As uuid As uuid

vcfComponentId

Optional

VCF component identifier (required when authSourceType is VCF_COMPONENT)

string As uuid As uuid

vcfComponentResourceId

Optional

VCF component resource ID for VCenter or NSX cluster

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"authSourceType":"string","ssoRealmId":"string"}' https://{api_host}/suite-api/api/fleet-management/iam/components/auth-sources

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE

Delete Iam Component Auth Source