REST API - create
  1. Operations
  2. vcenter
  3. identity
  4. foreign security principals

vcenter identity foreign security principals: create

Create a foreign security principal. If the same Id already exists, update the record. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Request:

HTTP request

POST https://{server}/rest/vcenter/identity/foreign-security-principals

Request Body Structure:

{
    "id" : "obj-103",
    "spec" : {
        "identity_provider_id" : "string",
        "domain" : "string",
        "name" : "string",
        "group_names" : [
            "string",
            "string"
        ],
        "group_ids" : [
            "string",
            "string"
        ]
    }
}

Request Body Parameters:

Name Type Description
bold = required
id string the principal identifier.
spec create_spec the information to create the principal.
spec.identity_provider_id string The identity provider that this principal belongs to. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.name string The name of the principal. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.domain string The domain that the principal belongs to. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
spec.group_names string[] The names of groups that the principal is a member of. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, the groups will be empty.
spec.group_ids string[] The ids of groups that the principal is a member of. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.

Optional. If unset, the groups will be empty.

Response:

HTTP Status Code: 200

None

Errors:

HTTP Status Code Type Description
403 unauthorized if authorization is not given to caller.
400 invalid_argument if id or spec contains invalid information