docs/dyn/admin_directory_v1.roleAssignments.html - platform/external/python/google-api-python-client - Git at Google

 <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.roleAssignments.html">roleAssignments</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="#delete">delete(customer, roleAssignmentId)</a></code></p>
 <p class="firstline">Deletes a role assignment.</p>
 <p class="toc_element">
   <code><a href="#get">get(customer, roleAssignmentId)</a></code></p>
 <p class="firstline">Retrieve a role assignment.</p>
 <p class="toc_element">
   <code><a href="#insert">insert(customer, body)</a></code></p>
 <p class="firstline">Creates a role assignment.</p>
 <p class="toc_element">
   <code><a href="#list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</a></code></p>
 <p class="firstline">Retrieves a paginated list of all roleAssignments.</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>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="delete">delete(customer, roleAssignmentId)</code>
   <pre>Deletes a role assignment.

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

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

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

 Returns:
   An object of the form:

     { # JSON template for roleAssignment resource in Directory API.
       "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
       "roleAssignmentId": "A String", # ID of this roleAssignment.
       "roleId": "A String", # The ID of the role that is assigned.
       "assignedTo": "A String", # The unique ID of the user this role is assigned to.
       "etag": "A String", # ETag of the resource.
       "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
           # - CUSTOMER
           # - ORG_UNIT
       "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
     }</pre>
 </div>

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

 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 roleAssignment resource in Directory API.
     "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
     "roleAssignmentId": "A String", # ID of this roleAssignment.
     "roleId": "A String", # The ID of the role that is assigned.
     "assignedTo": "A String", # The unique ID of the user this role is assigned to.
     "etag": "A String", # ETag of the resource.
     "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
         # - CUSTOMER
         # - ORG_UNIT
     "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
   }


 Returns:
   An object of the form:

     { # JSON template for roleAssignment resource in Directory API.
       "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
       "roleAssignmentId": "A String", # ID of this roleAssignment.
       "roleId": "A String", # The ID of the role that is assigned.
       "assignedTo": "A String", # The unique ID of the user this role is assigned to.
       "etag": "A String", # ETag of the resource.
       "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
           # - CUSTOMER
           # - ORG_UNIT
       "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
     }</pre>
 </div>

 <div class="method">
     <code class="details" id="list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</code>
   <pre>Retrieves a paginated list of all roleAssignments.

 Args:
   customer: string, Immutable ID of the G Suite account. (required)
   pageToken: string, Token to specify the next page in the list.
   roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
   maxResults: integer, Maximum number of results to return.
   userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.

 Returns:
   An object of the form:

     { # JSON response template for List roleAssignments operation in Directory API.
     "nextPageToken": "A String",
     "items": [ # A list of RoleAssignment resources.
       { # JSON template for roleAssignment resource in Directory API.
           "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
           "roleAssignmentId": "A String", # ID of this roleAssignment.
           "roleId": "A String", # The ID of the role that is assigned.
           "assignedTo": "A String", # The unique ID of the user this role is assigned to.
           "etag": "A String", # ETag of the resource.
           "scopeType": "A String", # The scope in which this role is assigned. Possible values are:
               # - CUSTOMER
               # - ORG_UNIT
           "orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
         },
     ],
     "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments.
     "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>

 </body></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.roleAssignments.html">roleAssignments</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="#delete">delete(customer, roleAssignmentId)</a></code></p>
	<p class="firstline">Deletes a role assignment.</p>
	<p class="toc_element">
	<code><a href="#get">get(customer, roleAssignmentId)</a></code></p>
	<p class="firstline">Retrieve a role assignment.</p>
	<p class="toc_element">
	<code><a href="#insert">insert(customer, body)</a></code></p>
	<p class="firstline">Creates a role assignment.</p>
	<p class="toc_element">
	<code><a href="#list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</a></code></p>
	<p class="firstline">Retrieves a paginated list of all roleAssignments.</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>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="delete">delete(customer, roleAssignmentId)</code>
	<pre>Deletes a role assignment.

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

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

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

	Returns:
	An object of the form:

	{ # JSON template for roleAssignment resource in Directory API.
	"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
	"roleAssignmentId": "A String", # ID of this roleAssignment.
	"roleId": "A String", # The ID of the role that is assigned.
	"assignedTo": "A String", # The unique ID of the user this role is assigned to.
	"etag": "A String", # ETag of the resource.
	"scopeType": "A String", # The scope in which this role is assigned. Possible values are:
	# - CUSTOMER
	# - ORG_UNIT
	"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
	}</pre>
	</div>

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

	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 roleAssignment resource in Directory API.
	"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
	"roleAssignmentId": "A String", # ID of this roleAssignment.
	"roleId": "A String", # The ID of the role that is assigned.
	"assignedTo": "A String", # The unique ID of the user this role is assigned to.
	"etag": "A String", # ETag of the resource.
	"scopeType": "A String", # The scope in which this role is assigned. Possible values are:
	# - CUSTOMER
	# - ORG_UNIT
	"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
	}


	Returns:
	An object of the form:

	{ # JSON template for roleAssignment resource in Directory API.
	"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
	"roleAssignmentId": "A String", # ID of this roleAssignment.
	"roleId": "A String", # The ID of the role that is assigned.
	"assignedTo": "A String", # The unique ID of the user this role is assigned to.
	"etag": "A String", # ETag of the resource.
	"scopeType": "A String", # The scope in which this role is assigned. Possible values are:
	# - CUSTOMER
	# - ORG_UNIT
	"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</code>
	<pre>Retrieves a paginated list of all roleAssignments.

	Args:
	customer: string, Immutable ID of the G Suite account. (required)
	pageToken: string, Token to specify the next page in the list.
	roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID.
	maxResults: integer, Maximum number of results to return.
	userKey: string, The user's primary email address, alias email address, or unique user ID. If included in the request, returns role assignments only for this user.

	Returns:
	An object of the form:

	{ # JSON response template for List roleAssignments operation in Directory API.
	"nextPageToken": "A String",
	"items": [ # A list of RoleAssignment resources.
	{ # JSON template for roleAssignment resource in Directory API.
	"kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment.
	"roleAssignmentId": "A String", # ID of this roleAssignment.
	"roleId": "A String", # The ID of the role that is assigned.
	"assignedTo": "A String", # The unique ID of the user this role is assigned to.
	"etag": "A String", # ETag of the resource.
	"scopeType": "A String", # The scope in which this role is assigned. Possible values are:
	# - CUSTOMER
	# - ORG_UNIT
	"orgUnitId": "A String", # If the role is restricted to an organization unit, this contains the ID for the organization unit the exercise of this role is restricted to.
	},
	],
	"kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments.
	"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>

	</body></html>