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)
角色的 ID。
|
roleName |
string
角色的名称。
|
roleDescription |
string
角色的简短说明。
|
rolePrivileges[] |
object
授予此角色的一组特权。
|
rolePrivileges[].serviceId |
string
此特权所适用的服务的经过混淆处理的 ID。此值随 Privileges.list() 一起返回。
|
rolePrivileges[].privilegeName |
string
特权的名称。
|
isSystemRole |
boolean
如果这是预定义的系统角色,则返回 true 。
|
isSuperAdminRole |
boolean
如果角色是超级用户角色,则返回 true 。
|
kind |
string
API 资源的类型。此值始终为 admin#directory#role 。
|
etag |
string
资源的 ETag。
|
方法 |
|
删除角色。 |
|
检索角色。 |
|
创建角色。 |
|
检索网域中所有角色的分页列表。 |
|
修补角色。 |
|
更新角色。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-24。
[null,null,["最后更新时间 (UTC):2025-07-24。"],[],[],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. |"]]