Provision Component Role

Provision Component Role
Create and provision Custom Component Role

Creates new custom component roles and provisions them to specified target components.The operation is asynchronous and returns a task ID to track the provisioning progress.

Request
URI
POST
https://{api_host}/suite-api/api/fleet-management/iam/components/roles
COPY
Request Body

List of custom component roles to create and provision to target components

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.
Responses
202

Custom role creation and provisioning 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 '{"sourceComponentId":"string","targetVcfInstances":["string"]}' https://{api_host}/suite-api/api/fleet-management/iam/components/roles
On This Page
Iam Apis Operations
GET
Get Eligible Components
DELETE
Delete Iam Component Auth Source
POST
Create Iam Component Auth Source
POST
Get Iam Component Auth Sources
GET
Get Component Roles
POST
Provision Component Role
PUT
Update Component Role
GET
Get Component Role Summaries
DELETE
Delete Component Role
GET
Get Component Role
POST
Trigger Drift Check
POST
Retry Apply For Role
GET
Get Component Role Definitions
POST
Configure IDP
PUT
Update IDP Configuration
DELETE
Delete IDP Configuration
GET
Get IDP Configuration
GET
Get Scim Sync Client Info
POST
Generate Scim Sync Client
GET
Get Ldap Directories
POST
Lookup Ldap Groups
POST
Execute Ldap Sync
GET
Get Ldap Sync Logs
GET
Get Ldap Sync Log By Id
GET
Get Ldap Sync Profile
PUT
Update Ldap Sync Profile
POST
Lookup Ldap Users
GET
Get VCF Roles Paginated
POST
Create Role
PUT
Update Role Definition
DELETE
Delete Role
GET
Get Role
POST
Validate Saml Metadata
GET
Get Iam Settings
PUT
Update Iam Settings
GET
Get Sso Realm List
POST
Create Sso Realm
DELETE
Delete Sso Realm
GET
Get Sso Realm
PATCH
Update Api Client
POST
Create Api Client
POST
Query Api Clients
DELETE
Delete Api Client
GET
Get Api Client
PATCH
Update Api Token
POST
Generate Api Token
POST
Query Api Tokens
DELETE
Delete Api Token
GET
Get Api Token
POST
Re Generate Api Token
GET
List Emergency Clients
POST
Create Emergency Client
DELETE
Delete Emergency Client
GET
Get Emergency Client
POST
Regenerate Emergency Client
POST
Get Groups List
POST
Get Group Members List
GET
List O Auth Apps
POST
Create O Auth App
PUT
Update O Auth App
DELETE
Delete O Auth App
GET
Get O Auth App
POST
Rotate O Auth App Secret
DELETE
Delete Role Assignments
GET
Get Role Assignment
PUT
Update Role Assignment
POST
Get Users List
GET
Get Iam Task Details
GET
Get Eligible Vidbs
PATCH
Update Vidb Metadata