Trigger Drift Check

Trigger Drift Check for Custom Role

Initiates a drift detection check for a custom role on specified target components. Drift detection identifies differences between the intended role definition in VCF Operations and the actual role configuration on target components (vCenter, NSX Manager, etc.). Use this to ensure roles are properly synchronized across your environment.

Request

URI

POST

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

COPY

Path Parameters

string

roleId

Required

Unique identifier of the custom role to check for drift

Request Body

Target components on which to perform drift detection

RoleSyncOperationTargets of type(s) application/json

Required

Show optional properties

{
    "targets": [
        {}
    ]
}

{
    "targets": [
        "string"
    ]
}

array of string

targets

Required

Constraints: minItems: 1

Target UUIDs for which drift/apply should be calculated

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

202

Drift check 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 POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"targets":["string"]}' https://{api_host}/suite-api/api/fleet-management/iam/components/roles/{roleId}/drift-check

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

202 Response Body

Iam Apis Operations