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.roleAssignments.html">roleAssignments</a></h1> 76 <h2>Instance Methods</h2> 77 <p class="toc_element"> 78 <code><a href="#delete">delete(customer, roleAssignmentId)</a></code></p> 79 <p class="firstline">Deletes a role assignment.</p> 80 <p class="toc_element"> 81 <code><a href="#get">get(customer, roleAssignmentId)</a></code></p> 82 <p class="firstline">Retrieve a role assignment.</p> 83 <p class="toc_element"> 84 <code><a href="#insert">insert(customer, body)</a></code></p> 85 <p class="firstline">Creates a role assignment.</p> 86 <p class="toc_element"> 87 <code><a href="#list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</a></code></p> 88 <p class="firstline">Retrieves a paginated list of all roleAssignments.</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 <h3>Method Details</h3> 93 <div class="method"> 94 <code class="details" id="delete">delete(customer, roleAssignmentId)</code> 95 <pre>Deletes a role assignment. 96 97 Args: 98 customer: string, Immutable ID of the G Suite account. (required) 99 roleAssignmentId: string, Immutable ID of the role assignment. (required) 100 </pre> 101 </div> 102 103 <div class="method"> 104 <code class="details" id="get">get(customer, roleAssignmentId)</code> 105 <pre>Retrieve a role assignment. 106 107 Args: 108 customer: string, Immutable ID of the G Suite account. (required) 109 roleAssignmentId: string, Immutable ID of the role assignment. (required) 110 111 Returns: 112 An object of the form: 113 114 { # JSON template for roleAssignment resource in Directory API. 115 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment. 116 "roleAssignmentId": "A String", # ID of this roleAssignment. 117 "roleId": "A String", # The ID of the role that is assigned. 118 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 119 "etag": "A String", # ETag of the resource. 120 "scopeType": "A String", # The scope in which this role is assigned. Possible values are: 121 # - CUSTOMER 122 # - ORG_UNIT 123 "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. 124 }</pre> 125 </div> 126 127 <div class="method"> 128 <code class="details" id="insert">insert(customer, body)</code> 129 <pre>Creates a role assignment. 130 131 Args: 132 customer: string, Immutable ID of the G Suite account. (required) 133 body: object, The request body. (required) 134 The object takes the form of: 135 136 { # JSON template for roleAssignment resource in Directory API. 137 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment. 138 "roleAssignmentId": "A String", # ID of this roleAssignment. 139 "roleId": "A String", # The ID of the role that is assigned. 140 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 141 "etag": "A String", # ETag of the resource. 142 "scopeType": "A String", # The scope in which this role is assigned. Possible values are: 143 # - CUSTOMER 144 # - ORG_UNIT 145 "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. 146 } 147 148 149 Returns: 150 An object of the form: 151 152 { # JSON template for roleAssignment resource in Directory API. 153 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment. 154 "roleAssignmentId": "A String", # ID of this roleAssignment. 155 "roleId": "A String", # The ID of the role that is assigned. 156 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 157 "etag": "A String", # ETag of the resource. 158 "scopeType": "A String", # The scope in which this role is assigned. Possible values are: 159 # - CUSTOMER 160 # - ORG_UNIT 161 "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. 162 }</pre> 163 </div> 164 165 <div class="method"> 166 <code class="details" id="list">list(customer, pageToken=None, roleId=None, maxResults=None, userKey=None)</code> 167 <pre>Retrieves a paginated list of all roleAssignments. 168 169 Args: 170 customer: string, Immutable ID of the G Suite account. (required) 171 pageToken: string, Token to specify the next page in the list. 172 roleId: string, Immutable ID of a role. If included in the request, returns only role assignments containing this role ID. 173 maxResults: integer, Maximum number of results to return. 174 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. 175 176 Returns: 177 An object of the form: 178 179 { # JSON response template for List roleAssignments operation in Directory API. 180 "nextPageToken": "A String", 181 "items": [ # A list of RoleAssignment resources. 182 { # JSON template for roleAssignment resource in Directory API. 183 "kind": "admin#directory#roleAssignment", # The type of the API resource. This is always admin#directory#roleAssignment. 184 "roleAssignmentId": "A String", # ID of this roleAssignment. 185 "roleId": "A String", # The ID of the role that is assigned. 186 "assignedTo": "A String", # The unique ID of the user this role is assigned to. 187 "etag": "A String", # ETag of the resource. 188 "scopeType": "A String", # The scope in which this role is assigned. Possible values are: 189 # - CUSTOMER 190 # - ORG_UNIT 191 "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. 192 }, 193 ], 194 "kind": "admin#directory#roleAssignments", # The type of the API resource. This is always admin#directory#roleAssignments. 195 "etag": "A String", # ETag of the resource. 196 }</pre> 197 </div> 198 199 <div class="method"> 200 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 201 <pre>Retrieves the next page of results. 202 203 Args: 204 previous_request: The request for the previous page. (required) 205 previous_response: The response from the request for the previous page. (required) 206 207 Returns: 208 A request object that you can call 'execute()' on to request the next 209 page. Returns None if there are no more items in the collection. 210 </pre> 211 </div> 212 213 </body></html>
