REST API - update

esx authentication client profiles: update

Update the access grants in an existing client profile.

Request:

HTTP request

PATCH https://{server}/api/esx/authentication/client-profiles/{profile}
{
    "grants"[
        {
            "resource_type""ENTITLEMENT",
            "entitlement""IDENTITY_MGMT"
        },
        {
            "resource_type""ENTITLEMENT",
            "entitlement""IDENTITY_MGMT"
        }
    ]
}

Path Parameters

Name Type Description
Required
profile string The client profile identifier.

Body Parameters:

Name Type Description
bold = required
- update_spec The new settings.
-.grants access_grant[] Access grants.

Optional. If unset, don't modify the access grants.

-.grants[].resource_type string Type of permission entity.

Defines the types of esx.authentication.client_profiles.access_grant elements in a client profile. These are permission resource types. There is support for entitlements, but not for groups. Value is one of:
ENTITLEMENT: Permission entitlements.

These are coarse-grained permissions that are not associated with an object, i.e. they are system-wide.

-.grants[].entitlement string The entitlement in the access grant.

Defines all permission entitlements supported on the ESX.

These are coarse-grained permissions that are not associated with an object, i.e. they are system-wide.

Value is one of:
IDENTITY_MGMT: Allows modifying the identity configuration.

For example: esx.authentication.client_profiles, esx.authentication.trust.security_token_issuers.


SECURITY_MGMT: Allows modifying security configuration.

For example: KMS, Attestation.


READ_ONLY: Allows access to some read-only operations. Not all read-only operations are accessible with this entitlement. Check the specific operation documentation for the required authorization.Optional. It is only relevant when resource_type has value ENTITLEMENT. This field is optional and it is only relevant when the value of resource_type is ENTITLEMENT.

Response:

HTTP Status Code: 204

Headers:

None

Type:

None

Errors:

HTTP Status Code Type Description
404 not_found if the profile is not found.
400 invalid_argument if the esx.authentication.client_profiles.update_spec contains invalid data.
500 error if there is a problem storing the data.
401 unauthenticated if the user can not be authenticated.