Update Component Role

Update Custom Component Role

Updates an existing custom component role definition. The operation is asynchronous and returns a task ID.

Request

URI

PUT

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

COPY

Request Body

Updated custom component role definition

ComponentRole of type(s) application/json

Required

Show optional properties

{
    "sourceComponentId": "string",
    "targetVcfInstances": [
        {}
    ]
}

{
    "importedAt": 0,
    "provisionDetails": [
        {
            "components": [
                {
                    "componentId": "string",
                    "driftResult": "string",
                    "status": "string"
                }
            ],
            "summary": {
                "drifted": 0,
                "failed": 0,
                "inProgress": 0,
                "notProvisioned": 0,
                "provisioned": 0
            },
            "vcfInstanceId": "string"
        }
    ],
    "roleId": "string",
    "roleName": "string",
    "sourceComponentId": "string",
    "targetVcfInstances": [
        "string"
    ]
}

integer As int64 As int64

importedAt

Optional

The imported timestamp of the role for the specific instance

array of object

provisionDetails

Optional

Custom role provision details

string As uuid As uuid

roleId

Optional

ID of the Role

string

roleName

Optional

Name of the Role

string As uuid As uuid

sourceComponentId

Required

Source component details

array of string

targetVcfInstances

Required

VCF instances

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

202

Custom role update and action task initiated successfully

Returns IamTaskDetails of type(s) application/json

{
    "errorDetails": {
        "errorCode": "string",
        "errorMessage": "string",
        "timestamp": 0
    },
    "taskId": "string",
    "taskStatus": "string",
    "taskType": "string"
}

object

errorDetails

Optional

Error Details for sso task failure

string As uuid As uuid

taskId

Required

Identifier of the IAM task

string

taskStatus

Optional

State of the IAM task

Possible values are : QUEUED, IN_PROGRESS, FAILED, COMPLETED, UNKNOWN,

string

taskType

Optional

IAM Task Type

Possible values are : IDP_RESET, SSO_REALM_RESET, COMPONENT_CUSTOM_ROLE_SYNC, UNKNOWN,

Code Samples

COPY

                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"sourceComponentId":"string","targetVcfInstances":["string"]}' https://{api_host}/suite-api/api/fleet-management/iam/components/roles

On This Page

Description

Request

Request Body

Authentication

Response

202 Response Body

Iam Apis Operations

GET

Get Eligible Components

DELETE

Delete Iam Component Auth Source