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

vcenter identity foreign security principals: get

Retrieve foreign security principal based on the identifier. 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

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

Path Parameters

Name Type Description
Required
principal string the principal identifier or name.

Response:

HTTP Status Code: 200

Representation:

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

Response Type:

Name Type Description
bold = required
value info foreign security principal information.
value.id string The identifier 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.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.identity.ForeignSecurityPrincipals. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.identity.ForeignSecurityPrincipals.
value.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.
value.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.
value.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.
value.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.
value.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.

Errors:

HTTP Status Code Type Description
403 unauthorized if authorization is not given to caller.
404 not_found if the principal is not found.
400 invalid_argument if id contains invalid information