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 של המשאב.
|
Methods |
|
|
מחיקה של תפקיד. |
|
|
אחזור תפקיד. |
|
|
יצירת תפקיד. |
|
|
אחזור רשימה מחולקת לדפים של כל התפקידים בדומיין. |
|
|
תיקון תפקיד. |
|
|
עדכון תפקיד. |
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-24 (שעון UTC).
[null,null,["עדכון אחרון: 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. |"]]
