Home | History | Annotate | Download | only in dyn 
      1 <html><body>
      2 <style>
      3 
      4 body, h1, h2, h3, div, span, p, pre, a {
      5   margin: 0;
      6   padding: 0;
      7   border: 0;
      8   font-weight: inherit;
      9   font-style: inherit;
     10   font-size: 100%;
     11   font-family: inherit;
     12   vertical-align: baseline;
     13 }
     14 
     15 body {
     16   font-size: 13px;
     17   padding: 1em;
     18 }
     19 
     20 h1 {
     21   font-size: 26px;
     22   margin-bottom: 1em;
     23 }
     24 
     25 h2 {
     26   font-size: 24px;
     27   margin-bottom: 1em;
     28 }
     29 
     30 h3 {
     31   font-size: 20px;
     32   margin-bottom: 1em;
     33   margin-top: 1em;
     34 }
     35 
     36 pre, code {
     37   line-height: 1.5;
     38   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
     39 }
     40 
     41 pre {
     42   margin-top: 0.5em;
     43 }
     44 
     45 h1, h2, h3, p {
     46   font-family: Arial, sans serif;
     47 }
     48 
     49 h1, h2, h3 {
     50   border-bottom: solid #CCC 1px;
     51 }
     52 
     53 .toc_element {
     54   margin-top: 0.5em;
     55 }
     56 
     57 .firstline {
     58   margin-left: 2 em;
     59 }
     60 
     61 .method  {
     62   margin-top: 1em;
     63   border: solid 1px #CCC;
     64   padding: 1em;
     65   background: #EEE;
     66 }
     67 
     68 .details {
     69   font-weight: bold;
     70   font-size: 14px;
     71 }
     72 
     73 </style>
     74 
     75 <h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.roles.html">roles</a></h1>
     76 <h2>Instance Methods</h2>
     77 <p class="toc_element">
     78   <code><a href="#delete">delete(customer, roleId)</a></code></p>
     79 <p class="firstline">Deletes a role.</p>
     80 <p class="toc_element">
     81   <code><a href="#get">get(customer, roleId)</a></code></p>
     82 <p class="firstline">Retrieves a role.</p>
     83 <p class="toc_element">
     84   <code><a href="#insert">insert(customer, body)</a></code></p>
     85 <p class="firstline">Creates a role.</p>
     86 <p class="toc_element">
     87   <code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
     88 <p class="firstline">Retrieves a paginated list of all the roles in a domain.</p>
     89 <p class="toc_element">
     90   <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
     91 <p class="firstline">Retrieves the next page of results.</p>
     92 <p class="toc_element">
     93   <code><a href="#patch">patch(customer, roleId, body)</a></code></p>
     94 <p class="firstline">Updates a role. This method supports patch semantics.</p>
     95 <p class="toc_element">
     96   <code><a href="#update">update(customer, roleId, body)</a></code></p>
     97 <p class="firstline">Updates a role.</p>
     98 <h3>Method Details</h3>
     99 <div class="method">
    100     <code class="details" id="delete">delete(customer, roleId)</code>
    101   <pre>Deletes a role.
    102 
    103 Args:
    104   customer: string, Immutable ID of the G Suite account. (required)
    105   roleId: string, Immutable ID of the role. (required)
    106 </pre>
    107 </div>
    108 
    109 <div class="method">
    110     <code class="details" id="get">get(customer, roleId)</code>
    111   <pre>Retrieves a role.
    112 
    113 Args:
    114   customer: string, Immutable ID of the G Suite account. (required)
    115   roleId: string, Immutable ID of the role. (required)
    116 
    117 Returns:
    118   An object of the form:
    119 
    120     { # JSON template for role resource in Directory API.
    121       "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    122       "roleId": "A String", # ID of the role.
    123       "roleDescription": "A String", # A short description of the role.
    124       "etag": "A String", # ETag of the resource.
    125       "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    126       "roleName": "A String", # Name of the role.
    127       "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    128       "rolePrivileges": [ # The set of privileges that are granted to this role.
    129         {
    130           "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    131           "privilegeName": "A String", # The name of the privilege.
    132         },
    133       ],
    134     }</pre>
    135 </div>
    136 
    137 <div class="method">
    138     <code class="details" id="insert">insert(customer, body)</code>
    139   <pre>Creates a role.
    140 
    141 Args:
    142   customer: string, Immutable ID of the G Suite account. (required)
    143   body: object, The request body. (required)
    144     The object takes the form of:
    145 
    146 { # JSON template for role resource in Directory API.
    147     "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    148     "roleId": "A String", # ID of the role.
    149     "roleDescription": "A String", # A short description of the role.
    150     "etag": "A String", # ETag of the resource.
    151     "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    152     "roleName": "A String", # Name of the role.
    153     "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    154     "rolePrivileges": [ # The set of privileges that are granted to this role.
    155       {
    156         "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    157         "privilegeName": "A String", # The name of the privilege.
    158       },
    159     ],
    160   }
    161 
    162 
    163 Returns:
    164   An object of the form:
    165 
    166     { # JSON template for role resource in Directory API.
    167       "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    168       "roleId": "A String", # ID of the role.
    169       "roleDescription": "A String", # A short description of the role.
    170       "etag": "A String", # ETag of the resource.
    171       "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    172       "roleName": "A String", # Name of the role.
    173       "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    174       "rolePrivileges": [ # The set of privileges that are granted to this role.
    175         {
    176           "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    177           "privilegeName": "A String", # The name of the privilege.
    178         },
    179       ],
    180     }</pre>
    181 </div>
    182 
    183 <div class="method">
    184     <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
    185   <pre>Retrieves a paginated list of all the roles in a domain.
    186 
    187 Args:
    188   customer: string, Immutable ID of the G Suite account. (required)
    189   pageToken: string, Token to specify the next page in the list.
    190   maxResults: integer, Maximum number of results to return.
    191 
    192 Returns:
    193   An object of the form:
    194 
    195     { # JSON response template for List roles operation in Directory API.
    196     "nextPageToken": "A String",
    197     "items": [ # A list of Role resources.
    198       { # JSON template for role resource in Directory API.
    199           "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    200           "roleId": "A String", # ID of the role.
    201           "roleDescription": "A String", # A short description of the role.
    202           "etag": "A String", # ETag of the resource.
    203           "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    204           "roleName": "A String", # Name of the role.
    205           "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    206           "rolePrivileges": [ # The set of privileges that are granted to this role.
    207             {
    208               "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    209               "privilegeName": "A String", # The name of the privilege.
    210             },
    211           ],
    212         },
    213     ],
    214     "kind": "admin#directory#roles", # The type of the API resource. This is always admin#directory#roles.
    215     "etag": "A String", # ETag of the resource.
    216   }</pre>
    217 </div>
    218 
    219 <div class="method">
    220     <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
    221   <pre>Retrieves the next page of results.
    222 
    223 Args:
    224   previous_request: The request for the previous page. (required)
    225   previous_response: The response from the request for the previous page. (required)
    226 
    227 Returns:
    228   A request object that you can call 'execute()' on to request the next
    229   page. Returns None if there are no more items in the collection.
    230     </pre>
    231 </div>
    232 
    233 <div class="method">
    234     <code class="details" id="patch">patch(customer, roleId, body)</code>
    235   <pre>Updates a role. This method supports patch semantics.
    236 
    237 Args:
    238   customer: string, Immutable ID of the G Suite account. (required)
    239   roleId: string, Immutable ID of the role. (required)
    240   body: object, The request body. (required)
    241     The object takes the form of:
    242 
    243 { # JSON template for role resource in Directory API.
    244     "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    245     "roleId": "A String", # ID of the role.
    246     "roleDescription": "A String", # A short description of the role.
    247     "etag": "A String", # ETag of the resource.
    248     "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    249     "roleName": "A String", # Name of the role.
    250     "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    251     "rolePrivileges": [ # The set of privileges that are granted to this role.
    252       {
    253         "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    254         "privilegeName": "A String", # The name of the privilege.
    255       },
    256     ],
    257   }
    258 
    259 
    260 Returns:
    261   An object of the form:
    262 
    263     { # JSON template for role resource in Directory API.
    264       "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    265       "roleId": "A String", # ID of the role.
    266       "roleDescription": "A String", # A short description of the role.
    267       "etag": "A String", # ETag of the resource.
    268       "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    269       "roleName": "A String", # Name of the role.
    270       "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    271       "rolePrivileges": [ # The set of privileges that are granted to this role.
    272         {
    273           "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    274           "privilegeName": "A String", # The name of the privilege.
    275         },
    276       ],
    277     }</pre>
    278 </div>
    279 
    280 <div class="method">
    281     <code class="details" id="update">update(customer, roleId, body)</code>
    282   <pre>Updates a role.
    283 
    284 Args:
    285   customer: string, Immutable ID of the G Suite account. (required)
    286   roleId: string, Immutable ID of the role. (required)
    287   body: object, The request body. (required)
    288     The object takes the form of:
    289 
    290 { # JSON template for role resource in Directory API.
    291     "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    292     "roleId": "A String", # ID of the role.
    293     "roleDescription": "A String", # A short description of the role.
    294     "etag": "A String", # ETag of the resource.
    295     "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    296     "roleName": "A String", # Name of the role.
    297     "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    298     "rolePrivileges": [ # The set of privileges that are granted to this role.
    299       {
    300         "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    301         "privilegeName": "A String", # The name of the privilege.
    302       },
    303     ],
    304   }
    305 
    306 
    307 Returns:
    308   An object of the form:
    309 
    310     { # JSON template for role resource in Directory API.
    311       "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    312       "roleId": "A String", # ID of the role.
    313       "roleDescription": "A String", # A short description of the role.
    314       "etag": "A String", # ETag of the resource.
    315       "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    316       "roleName": "A String", # Name of the role.
    317       "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    318       "rolePrivileges": [ # The set of privileges that are granted to this role.
    319         {
    320           "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
    321           "privilegeName": "A String", # The name of the privilege.
    322         },
    323       ],
    324     }</pre>
    325 </div>
    326 
    327 </body></html>