Developer Documentation
Create Access
Released in v7.0.0Set up access control for the subject on given domain on the namespace.
Request
URLURL
https://{api_host}/api/vcenter/namespaces/instances/{namespace}/access/{domain}/{subject}
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Identifier for the namespace. The parameter must be an identifier for the resource type: com.vmware.vcenter.namespaces.Instance. |
| required |
|
string | The domain of the subject. |
| required |
|
string | The principal for this operation. |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
AccessSubjectType | The type of subject (user or group). |
Request Body
Request Body
Contains
AccessCreateSpec
of type application/json
(required)
{
"role": "enum"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | role | AccessRole Enum |
Role to be assigned. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user does not have Namespaces.Configure privilege or the namespace identifier begins with "vmware-system" prefix. |
| 404 | Error | com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.not_found : if namespace cannot be located. |
| 409 | Error | com.vmware.vapi.std.errors.already_exists : if the specified principal on given domain is already associated with a role on the namespace. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the namespace is marked for deletion or the associated cluster is being disabled. |
| default | Error | Not available |
