Patch
|
|||||
|
|
||||
Patch role via Apiary Patch Orchestration
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage delegated admin roles for your domain
Input
This building block consumes 12 input parameters
| Name | Format | Description |
|---|---|---|
customer Required |
STRING |
Immutable ID of the G Suite account |
roleId Required |
STRING |
Immutable ID of the role |
rolePrivileges[] |
OBJECT |
|
rolePrivileges[].serviceId |
STRING |
The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
rolePrivileges[].privilegeName |
STRING |
The name of the privilege |
isSuperAdminRole |
BOOLEAN |
Returns true if the role is a super admin role |
roleId |
INTEGER |
ID of the role |
isSystemRole |
BOOLEAN |
Returns true if this is a pre-defined system role |
etag |
STRING |
ETag of the resource |
roleDescription |
STRING |
A short description of the role |
kind |
STRING |
The type of the API resource. This is always admin#directory#role |
roleName |
STRING |
Name of the role |
= Parameter name
= Format
|
customer STRING Required Immutable ID of the G Suite account |
|
roleId STRING Required Immutable ID of the role |
|
rolePrivileges[] OBJECT |
|
rolePrivileges[].serviceId STRING The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
|
rolePrivileges[].privilegeName STRING The name of the privilege |
|
isSuperAdminRole BOOLEAN Returns true if the role is a super admin role |
|
roleId INTEGER ID of the role |
|
isSystemRole BOOLEAN Returns true if this is a pre-defined system role |
|
etag STRING ETag of the resource |
|
roleDescription STRING A short description of the role |
|
kind STRING The type of the API resource. This is always admin#directory#role |
|
roleName STRING Name of the role |
Output
This building block provides 10 output parameters
| Name | Format | Description |
|---|---|---|
rolePrivileges[] |
OBJECT |
|
rolePrivileges[].serviceId |
STRING |
The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
rolePrivileges[].privilegeName |
STRING |
The name of the privilege |
isSuperAdminRole |
BOOLEAN |
Returns true if the role is a super admin role |
roleId |
INTEGER |
ID of the role |
isSystemRole |
BOOLEAN |
Returns true if this is a pre-defined system role |
etag |
STRING |
ETag of the resource |
roleDescription |
STRING |
A short description of the role |
kind |
STRING |
The type of the API resource. This is always admin#directory#role |
roleName |
STRING |
Name of the role |
= Parameter name
= Format
|
rolePrivileges[] OBJECT |
|
rolePrivileges[].serviceId STRING The obfuscated ID of the service this privilege is for. This value is returned with Privileges.list() |
|
rolePrivileges[].privilegeName STRING The name of the privilege |
|
isSuperAdminRole BOOLEAN Returns true if the role is a super admin role |
|
roleId INTEGER ID of the role |
|
isSystemRole BOOLEAN Returns true if this is a pre-defined system role |
|
etag STRING ETag of the resource |
|
roleDescription STRING A short description of the role |
|
kind STRING The type of the API resource. This is always admin#directory#role |
|
roleName STRING Name of the role |