docs/dyn/admin_directory_v1.roles.html

<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="admin_directory_v1.html">Admin Directory API</a> . <a href="admin_directory_v1.roles.html">roles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#delete">delete(customer, roleId)</a></code></p>
<p class="firstline">Deletes a role.</p>
<p class="toc_element">
  <code><a href="#get">get(customer, roleId)</a></code></p>
<p class="firstline">Retrieves a role.</p>
<p class="toc_element">
  <code><a href="#insert">insert(customer, body)</a></code></p>
<p class="firstline">Creates a role.</p>
<p class="toc_element">
  <code><a href="#list">list(customer, pageToken=None, maxResults=None)</a></code></p>
<p class="firstline">Retrieves a paginated list of all the roles in a domain.</p>
<p class="toc_element">
  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
  <code><a href="#patch">patch(customer, roleId, body)</a></code></p>
<p class="firstline">Updates a role. This method supports patch semantics.</p>
<p class="toc_element">
  <code><a href="#update">update(customer, roleId, body)</a></code></p>
<p class="firstline">Updates a role.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="delete">delete(customer, roleId)</code>
  <pre>Deletes a role.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleId: string, Immutable ID of the role. (required)
</pre>
</div>

<div class="method">
    <code class="details" id="get">get(customer, roleId)</code>
  <pre>Retrieves a role.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleId: string, Immutable ID of the role. (required)

Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="insert">insert(customer, body)</code>
  <pre>Creates a role.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="list">list(customer, pageToken=None, maxResults=None)</code>
  <pre>Retrieves a paginated list of all the roles in a domain.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  pageToken: string, Token to specify the next page in the list.
  maxResults: integer, Maximum number of results to return.

Returns:
  An object of the form:

    { # JSON response template for List roles operation in Directory API.
    "nextPageToken": "A String",
    "items": [ # A list of Role resources.
      { # JSON template for role resource in Directory API.
          "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
          "roleId": "A String", # ID of the role.
          "roleDescription": "A String", # A short description of the role.
          "etag": "A String", # ETag of the resource.
          "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
          "roleName": "A String", # Name of the role.
          "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
          "rolePrivileges": [ # The set of privileges that are granted to this role.
            {
              "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
              "privilegeName": "A String", # The name of the privilege.
            },
          ],
        },
    ],
    "kind": "admin#directory#roles", # The type of the API resource. This is always admin#directory#roles.
    "etag": "A String", # ETag of the resource.
  }</pre>
</div>

<div class="method">
    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
  <pre>Retrieves the next page of results.

Args:
  previous_request: The request for the previous page. (required)
  previous_response: The response from the request for the previous page. (required)

Returns:
  A request object that you can call 'execute()' on to request the next
  page. Returns None if there are no more items in the collection.
    </pre>
</div>

<div class="method">
    <code class="details" id="patch">patch(customer, roleId, body)</code>
  <pre>Updates a role. This method supports patch semantics.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleId: string, Immutable ID of the role. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }</pre>
</div>

<div class="method">
    <code class="details" id="update">update(customer, roleId, body)</code>
  <pre>Updates a role.

Args:
  customer: string, Immutable ID of the G Suite account. (required)
  roleId: string, Immutable ID of the role. (required)
  body: object, The request body. (required)
    The object takes the form of:

{ # JSON template for role resource in Directory API.
    "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
    "roleId": "A String", # ID of the role.
    "roleDescription": "A String", # A short description of the role.
    "etag": "A String", # ETag of the resource.
    "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
    "roleName": "A String", # Name of the role.
    "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
    "rolePrivileges": [ # The set of privileges that are granted to this role.
      {
        "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
        "privilegeName": "A String", # The name of the privilege.
      },
    ],
  }


Returns:
  An object of the form:

    { # JSON template for role resource in Directory API.
      "kind": "admin#directory#role", # The type of the API resource. This is always admin#directory#role.
      "roleId": "A String", # ID of the role.
      "roleDescription": "A String", # A short description of the role.
      "etag": "A String", # ETag of the resource.
      "isSuperAdminRole": True or False, # Returns true if the role is a super admin role.
      "roleName": "A String", # Name of the role.
      "isSystemRole": True or False, # Returns true if this is a pre-defined system role.
      "rolePrivileges": [ # The set of privileges that are granted to this role.
        {
          "serviceId": "A String", # The obfuscated ID of the service this privilege is for.
          "privilegeName": "A String", # The name of the privilege.
        },
      ],
    }</pre>
</div>

</body></html>