REST Resource: roles
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
Recurso: função
Representação JSON |
{
"roleId": string,
"roleName": string,
"roleDescription": string,
"rolePrivileges": [
{
"serviceId": string,
"privilegeName": string
}
],
"isSystemRole": boolean,
"isSuperAdminRole": boolean,
"kind": string,
"etag": string
} |
Campos |
roleId |
string (int64 format)
ID da função.
|
roleName |
string
Nome da função.
|
roleDescription |
string
Uma breve descrição da função.
|
rolePrivileges[] |
object
O conjunto de privilégios concedidos a essa função.
|
rolePrivileges[].serviceId |
string
O ID ofuscado do serviço a que esse privilégio se destina. Esse valor é retornado com Privileges.list() .
|
rolePrivileges[].privilegeName |
string
O nome do privilégio.
|
isSystemRole |
boolean
Retorna true se essa for uma função do sistema predefinida.
|
isSuperAdminRole |
boolean
Retorna true se a função for de superadministrador.
|
kind |
string
O tipo do recurso da API. Isso é sempre admin#directory#role .
|
etag |
string
ETag do recurso.
|
Métodos |
|
Exclui um papel. |
|
Recupera um papel. |
|
Cria uma função. |
|
Recupera uma lista paginada de todos os papéis em um domínio. |
|
Adiciona patches a uma função. |
|
Atualiza uma função. |
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-07-24 UTC.
[null,null,["Última atualização 2025-07-24 UTC."],[],[],null,["# REST Resource: roles\n\nResource: Role\n--------------\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"roleId\": string, \"roleName\": string, \"roleDescription\": string, \"rolePrivileges\": [ { \"serviceId\": string, \"privilegeName\": string } ], \"isSystemRole\": boolean, \"isSuperAdminRole\": boolean, \"kind\": string, \"etag\": string } ``` |\n\n| Fields ||\n|----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `roleId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` ID of the role. |\n| `roleName` | `string` Name of the role. |\n| `roleDescription` | `string` A short description of the role. |\n| `rolePrivileges[]` | `object` The set of privileges that are granted to this role. |\n| `rolePrivileges[].serviceId` | `string` The obfuscated ID of the service this privilege is for. This value is returned with [`Privileges.list()`](https://developers.google.com/workspace/admin/directory/v1/reference/privileges/list). |\n| `rolePrivileges[].privilegeName` | `string` The name of the privilege. |\n| `isSystemRole` | `boolean` Returns `true` if this is a pre-defined system role. |\n| `isSuperAdminRole` | `boolean` Returns `true` if the role is a super admin role. |\n| `kind` | `string` The type of the API resource. This is always `admin#directory#role`. |\n| `etag` | `string` ETag of the resource. |\n\n| Methods ------- ||\n|-------------------------------------------------------------------------|----------------------------------------------------------|\n| ### [delete](/workspace/admin/directory/reference/rest/v1/roles/delete) | Deletes a role. |\n| ### [get](/workspace/admin/directory/reference/rest/v1/roles/get) | Retrieves a role. |\n| ### [insert](/workspace/admin/directory/reference/rest/v1/roles/insert) | Creates a role. |\n| ### [list](/workspace/admin/directory/reference/rest/v1/roles/list) | Retrieves a paginated list of all the roles in a domain. |\n| ### [patch](/workspace/admin/directory/reference/rest/v1/roles/patch) | Patches a role. |\n| ### [update](/workspace/admin/directory/reference/rest/v1/roles/update) | Updates a role. |"]]