REST Resource: roles
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
Recurso: Rol
| Representación 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)
Es el ID del rol.
|
roleName |
string
Nombre del rol.
|
roleDescription |
string
Es una descripción breve del puesto.
|
rolePrivileges[] |
object
Es el conjunto de privilegios que se otorgan a este rol.
|
rolePrivileges[].serviceId |
string
El ID ofuscado del servicio para el que se aplica este privilegio. Este valor se muestra con Privileges.list().
|
rolePrivileges[].privilegeName |
string
Es el nombre del privilegio.
|
isSystemRole |
boolean
Muestra true si se trata de un rol del sistema predefinido.
|
isSuperAdminRole |
boolean
Muestra true si el rol es de administrador avanzado.
|
kind |
string
Tipo de recurso de la API. Siempre es admin#directory#role.
|
etag |
string
ETag del recurso.
|
Métodos |
|
|
Borra un rol. |
|
|
Recupera un rol. |
|
|
Crea un rol. |
|
|
Recupera una lista paginada de todos los roles de un dominio. |
|
|
Aplica parches a un rol. |
|
|
Actualiza un rol. |
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-07-24 (UTC)
[null,null,["Última actualización: 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. |"]]
