REST Resource: roles
Оптимизируйте свои подборки
Сохраняйте и классифицируйте контент в соответствии со своими настройками.
Ресурс: Роль
JSON-представление |
---|
{
"roleId": string,
"roleName": string,
"roleDescription": string,
"rolePrivileges": [
{
"serviceId": string,
"privilegeName": string
}
],
"isSystemRole": boolean,
"isSuperAdminRole": boolean,
"kind": string,
"etag": string
} |
Поля |
---|
roleId | string ( int64 format) Идентификатор роли. |
roleName | string Название роли. |
roleDescription | string Краткое описание роли. |
rolePrivileges[] | object Набор привилегий, предоставленных этой роли. |
rolePrivileges[].serviceId | string Скрытый идентификатор службы, для которой предназначена эта привилегия. Это значение возвращается с помощью Privileges.list() . |
rolePrivileges[].privilegeName | string Название привилегии. |
isSystemRole | boolean Возвращает true , если это предопределенная системная роль. |
isSuperAdminRole | boolean Возвращает true , если роль является ролью суперадминистратора. |
kind | string Тип ресурса API. Это всегда admin#directory#role . |
etag | string ETag ресурса. |
Методы |
---|
| Удаляет роль. |
| Получает роль. |
| Создает роль. |
| Получает постраничный список всех ролей в домене. |
| Исправляет роль. |
| Обновляет роль. |
Если не указано иное, контент на этой странице предоставляется по лицензии Creative Commons "С указанием авторства 4.0", а примеры кода – по лицензии Apache 2.0. Подробнее об этом написано в правилах сайта. Java – это зарегистрированный товарный знак корпорации Oracle и ее аффилированных лиц.
Последнее обновление: 2025-07-28 UTC.
[null,null,["Последнее обновление: 2025-07-28 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. |"]]