# Client APIs

> List of Client APIs.

Source: https://www.thethingsindustries.com/docs/api/reference/grpc/client/


List of Client APIs.

## The `ClientRegistry` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Create</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Create a new OAuth client. This also sets the given organization or user as
first collaborator with all possible rights.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateClientRequest"><code>CreateClientRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Client"><code>Client</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/users/{collaborator.user_ids.user_id}/clients</code></p>
        <p><code>POST</code> <code>/api/v3/organizations/{collaborator.organization_ids.organization_id}/clients</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Get</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Get the OAuth client with the given identifiers, selecting the fields specified
in the field mask.
More or less fields may be returned, depending on the rights of the caller.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetClientRequest"><code>GetClientRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Client"><code>Client</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/clients/{client_ids.client_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.List</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List OAuth clients where the given user or organization is a direct collaborator.
If no user or organization is given, this returns the OAuth clients the caller
has access to.
Similar to Get, this selects the fields specified in the field mask.
More or less fields may be returned, depending on the rights of the caller.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListClientsRequest"><code>ListClientsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Clients"><code>Clients</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/clients</code></p>
        <p><code>GET</code> <code>/api/v3/users/{collaborator.user_ids.user_id}/clients</code></p>
        <p><code>GET</code> <code>/api/v3/organizations/{collaborator.organization_ids.organization_id}/clients</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Update</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Update the OAuth client, changing the fields specified by the field mask to the provided values.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UpdateClientRequest"><code>UpdateClientRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Client"><code>Client</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>PUT</code> <code>/api/v3/clients/{client.ids.client_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Delete</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Delete the OAuth client. This may not release the client ID for reuse.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ClientIdentifiers"><code>ClientIdentifiers</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <code>google.protobuf.Empty</code>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>DELETE</code> <code>/api/v3/clients/{client_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Restore</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        <p>Restore a recently deleted client.</p>
<p>Deployment configuration may specify if, and for how long after deletion,
entities can be restored.</p>

      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ClientIdentifiers"><code>ClientIdentifiers</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <code>google.protobuf.Empty</code>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/clients/{client_id}/restore</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientRegistry.Purge</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Purge the client. This will release the client ID for reuse.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ClientIdentifiers"><code>ClientIdentifiers</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <code>google.protobuf.Empty</code>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>DELETE</code> <code>/api/v3/clients/{client_id}/purge</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `ClientAccess` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientAccess.ListRights</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the rights the caller has on this application.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ClientIdentifiers"><code>ClientIdentifiers</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Rights"><code>Rights</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/clients/{client_id}/rights</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientAccess.GetCollaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Get the rights of a collaborator (member) of the client.
Pseudo-rights in the response (such as the &ldquo;_ALL&rdquo; right) are not expanded.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetClientCollaboratorRequest"><code>GetClientCollaboratorRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:GetCollaboratorResponse"><code>GetCollaboratorResponse</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code></code> <code>/api/v3</code></p>
        <p><code>GET</code> <code>/api/v3/clients/{client_ids.client_id}/collaborator/user/{collaborator.user_ids.user_id}</code></p>
        <p><code>GET</code> <code>/api/v3/clients/{client_ids.client_id}/collaborator/organization/{collaborator.organization_ids.organization_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientAccess.DeleteCollaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        DeleteCollaborator removes a collaborator from a client.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:DeleteClientCollaboratorRequest"><code>DeleteClientCollaboratorRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <code>google.protobuf.Empty</code>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code></code> <code>/api/v3</code></p>
        <p><code>DELETE</code> <code>/api/v3/clients/{client_ids.client_id}/collaborators/user/{collaborator_ids.user_ids.user_id}</code></p>
        <p><code>DELETE</code> <code>/api/v3/clients/{client_ids.client_id}/collaborators/organization/{collaborator_ids.organization_ids.organization_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientAccess.SetCollaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Set the rights of a collaborator (member) on the OAuth client.
This method can also be used to delete the collaborator, by giving them no rights.
The caller is required to have all assigned or/and removed rights.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:SetClientCollaboratorRequest"><code>SetClientCollaboratorRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <code>google.protobuf.Empty</code>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>PUT</code> <code>/api/v3/clients/{client_ids.client_id}/collaborators</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ClientAccess.ListCollaborators</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the collaborators on this OAuth client.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListClientCollaboratorsRequest"><code>ListClientCollaboratorsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Collaborators"><code>Collaborators</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/clients/{client_ids.client_id}/collaborators</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `EntityRegistrySearch` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>EntityRegistrySearch.SearchClients</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Search for OAuth clients that match the conditions specified in the request.
Non-admin users will only match OAuth clients that they have rights on.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:SearchClientsRequest"><code>SearchClientsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Clients"><code>Clients</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/search/clients</code></p>
      </td>
    </tr>
  </tbody>
</table>


## Messages


<h3 id="message:Client">Message <code>Client</code></h3>
<p>An OAuth client on the network.</p>

<details><summary>Show object example</summary>
<pre><code>{
  "ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "deleted_at": "0001-01-01T00:00:00Z",
  "name": "",
  "description": "",
  "attributes": {},
  "contact_info": [],
  "administrative_contact": {},
  "technical_contact": {},
  "secret": "",
  "redirect_uris": [],
  "logout_redirect_uris": [],
  "state": "STATE_REQUESTED",
  "state_description": "",
  "skip_authorization": false,
  "endorsed": false,
  "grants": [],
  "rights": [],
  "label_ids": [],
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The identifiers of the OAuth client. These are public and can be seen by any authenticated user in the network.</p>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>created_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>When the OAuth client was created. This information is public and can be seen by any authenticated user in the network.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>updated_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>When the OAuth client was last updated. This information is public and can be seen by any authenticated user in the network.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>deleted_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>When the OAuth client was deleted. This information is public and can be seen by any authenticated user in the network.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>name</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The name of the OAuth client. This information is public and can be seen by any authenticated user in the network.</p>
          <p><code>max_len</code>: <code>50</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>description</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>A description for the OAuth client. This information is public and can be seen by any authenticated user in the network.</p>
          <p><code>max_len</code>: <code>2000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>attributes</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        map of 
  <code>string</code>
 to 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Key-value attributes for this client. Typically used for organizing clients or for storing integration-specific data.</p>
          <p><code>max_pairs</code>: <code>10</code></p>
            <p><code>max_len</code> (key): <code>36</code></p>
            <p><code>pattern</code> (key): <code>^[a-z0-9](?:[-]?[a-z0-9]){2,}$</code></p>
        
            <p><code>max_len</code> (value): <code>200</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>contact_info</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#message:ContactInfo">
  
  <code>
    
    ContactInfo
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Contact information for this client. Typically used to indicate who to contact with technical/security questions about the application.
This information is public and can be seen by any authenticated user in the network.
This field is deprecated. Use administrative_contact and technical_contact instead.</p>
          <p><code>max_items</code>: <code>10</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>administrative_contact</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>technical_contact</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>secret</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The client secret is only visible to collaborators of the client.</p>
          <p><code>max_len</code>: <code>128</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>redirect_uris</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
        
        repeated 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The allowed redirect URIs against which authorization requests are checked.
If the authorization request does not pass a redirect URI, the first one
from this list is taken.
This information is public and can be seen by any authenticated user in the network.</p>
          <p><code>max_items</code>: <code>10</code></p>
            <p><code>max_len</code>: <code>128</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>logout_redirect_uris</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
        
        repeated 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The allowed logout redirect URIs against which client initiated logout
requests are checked. If the authorization request does not pass a redirect
URI, the first one from this list is taken.
This information is public and can be seen by any authenticated user in the network.</p>
          <p><code>max_items</code>: <code>10</code></p>
            <p><code>max_len</code>: <code>128</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>state</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:State">
  
  <code>
  
  State
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The reviewing state of the client.
This information is public and can be seen by any authenticated user in the network.
This field can only be modified by admins.
If state_description is not updated when updating state, state_description is cleared.</p>
          <p><code>defined_only</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>state_description</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>A description for the state field.
This field can only be modified by admins, and should typically only be updated
when also updating <code>state</code>.</p>
          <p><code>max_len</code>: <code>128</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>skip_authorization</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>If set, the authorization page will be skipped.
This information is public and can be seen by any authenticated user in the network.
This field can only be modified by admins.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>endorsed</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>If set, the authorization page will show endorsement.
This information is public and can be seen by any authenticated user in the network.
This field can only be modified by admins.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>grants</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:GrantType">
  
  <code>
  
  GrantType
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>OAuth flows that can be used for the client to get a token.
This information is public and can be seen by any authenticated user in the network.
After a client is created, this field can only be modified by admins.</p>
            <p><code>defined_only</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>rights</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:Right">
  
  <code>
  
  Right
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Rights denotes what rights the client will have access to.
This information is public and can be seen by any authenticated user in the network.
Users that previously authorized this client will have to re-authorize the
client after rights are added to this list.</p>
            <p><code>defined_only</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>label_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
        
        repeated 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
        
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:ClientIdentifiers">Message <code>ClientIdentifiers</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_id": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>max_len</code>: <code>36</code></p>
          <p><code>pattern</code>: <code>^[a-z0-9](?:[-]?[a-z0-9]){2,}$</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:CreateClientRequest">Message <code>CreateClientRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client": {},
  "collaborator": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:Client">
  
  <code>
    
    Client
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>collaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Collaborator to grant all rights on the newly created client.</p>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:Collaborator">Message <code>Collaborator</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "ids": {},
  "rights": [],
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>rights</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:Right">
  
  <code>
  
  Right
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
            <p><code>defined_only</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:ContactInfo">Message <code>ContactInfo</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "contact_type": "CONTACT_TYPE_OTHER",
  "contact_method": "CONTACT_METHOD_OTHER",
  "value": "",
  "public": false,
  "validated_at": "0001-01-01T00:00:00Z",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>contact_type</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:ContactType">
  
  <code>
  
  ContactType
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>defined_only</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>contact_method</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:ContactMethod">
  
  <code>
  
  ContactMethod
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>defined_only</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>value</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>max_len</code>: <code>256</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>public</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>validated_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:DeleteClientCollaboratorRequest">Message <code>DeleteClientCollaboratorRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_ids": {},
  "collaborator_ids": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>collaborator_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:GetClientCollaboratorRequest">Message <code>GetClientCollaboratorRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_ids": {},
  "collaborator": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>collaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:GetClientRequest">Message <code>GetClientRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_ids": {},
  "field_mask": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>field_mask</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    FieldMask
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The names of the client fields that should be returned.</p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:ListClientsRequest">Message <code>ListClientsRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "collaborator": {},
  "field_mask": {},
  "order": "",
  "limit": 0,
  "page": 0,
  "deleted": false,
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>collaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationOrUserIdentifiers">
  
  <code>
    
    OrganizationOrUserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>By default we list all OAuth clients the caller has rights on.
Set the user or the organization (not both) to instead list the OAuth clients
where the user or organization is collaborator on.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>field_mask</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    FieldMask
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The names of the client fields that should be returned.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>order</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Order the results by this field path (must be present in the field mask).
Default ordering is by ID. Prepend with a minus (-) to reverse the order.</p>
          <p><code>in</code>: <code>[ client_id -client_id name -name created_at -created_at]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Limit the number of results per page.</p>
          <p><code>lte</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>page</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Page number for pagination. 0 is interpreted as 1.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>deleted</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Only return recently deleted clients.</p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:ListClientCollaboratorsRequest">Message <code>ListClientCollaboratorsRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_ids": {},
  "limit": 0,
  "page": 0,
  "order": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Limit the number of results per page.</p>
          <p><code>lte</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>page</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Page number for pagination. 0 is interpreted as 1.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>order</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Order the results by this field path (must be present in the field mask).
Default ordering is by ID. Prepend with a minus (-) to reverse the order.</p>
          <p><code>in</code>: <code>[ id -id -rights rights]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:OrganizationIdentifiers">Message <code>OrganizationIdentifiers</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "organization_id": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>organization_id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>This ID shares namespace with user IDs.</p>
          <p><code>max_len</code>: <code>36</code></p>
          <p><code>pattern</code>: <code>^[a-z0-9](?:[-]?[a-z0-9]){2,}$</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:OrganizationOrUserIdentifiers">Message <code>OrganizationOrUserIdentifiers</code></h3>
<p>OrganizationOrUserIdentifiers contains either organization or user identifiers.</p>
<b>Restrictions:</b>
<ul>
  <li>Only one of <code>organization_ids</code>, <code>user_ids</code> can be set.</li>
</ul>

<details><summary>Show object example</summary>
<pre><code>{
  "organization_ids": {},
  "user_ids": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>organization_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:OrganizationIdentifiers">
  
  <code>
    
    OrganizationIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:SearchClientsRequest">Message <code>SearchClientsRequest</code></h3>
<p>This message is used for finding OAuth clients in the EntityRegistrySearch service.</p>

<details><summary>Show object example</summary>
<pre><code>{
  "query": "",
  "id_contains": "",
  "name_contains": "",
  "description_contains": "",
  "attributes_contain": {},
  "label_id_contains": [],
  "state": [],
  "field_mask": {},
  "order": "",
  "limit": 0,
  "page": 0,
  "deleted": false,
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>query</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the ID, name or description contains this substring.</p>
          <p><code>max_len</code>: <code>50</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>id_contains</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the ID contains this substring.</p>
          <p><code>max_len</code>: <code>50</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>name_contains</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the name contains this substring.</p>
          <p><code>max_len</code>: <code>50</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>description_contains</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the description contains this substring.</p>
          <p><code>max_len</code>: <code>50</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>attributes_contain</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        map of 
  <code>string</code>
 to 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the given attributes contain these substrings.</p>
          <p><code>max_pairs</code>: <code>10</code></p>
            <p><code>max_len</code> (key): <code>36</code></p>
            <p><code>pattern</code> (key): <code>^[a-z0-9](?:[-]?[a-z0-9]){2,}$</code></p>
        
            <p><code>max_len</code> (value): <code>50</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>label_id_contains</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
        
        repeated 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where one of the label_ids contains this substring.</p>
          <p><code>max_items</code>: <code>10</code></p>
            <p><code>max_len</code>: <code>50</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>state</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:State">
  
  <code>
  
  State
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Find OAuth clients where the state is any of these states.</p>
          <p><code>unique</code></p>
            <p><code>defined_only</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>field_mask</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    FieldMask
  </code>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>order</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Order the results by this field path (must be present in the field mask).
Default ordering is by ID. Prepend with a minus (-) to reverse the order.</p>
          <p><code>in</code>: <code>[ client_id -client_id name -name created_at -created_at]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Limit the number of results per page.</p>
          <p><code>lte</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>page</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>uint32</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Page number for pagination. 0 is interpreted as 1.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>deleted</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Only return recently deleted OAuth clients.</p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:SetClientCollaboratorRequest">Message <code>SetClientCollaboratorRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client_ids": {},
  "collaborator": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ClientIdentifiers">
  
  <code>
    
    ClientIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>collaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:Collaborator">
  
  <code>
    
    Collaborator
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:UpdateClientRequest">Message <code>UpdateClientRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "client": {},
  "field_mask": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>client</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:Client">
  
  <code>
    
    Client
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>field_mask</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    FieldMask
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The names of the client fields that should be updated.</p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:UserIdentifiers">Message <code>UserIdentifiers</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "user_id": "",
  "email": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user_id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>This ID shares namespace with organization IDs.</p>
          <p><code>max_len</code>: <code>36</code></p>
          <p><code>pattern</code>: <code>^[a-z0-9](?:[-]?[a-z0-9]){1,}$</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>email</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Secondary identifier, which can only be used in specific requests.</p>
      </td>
    </tr>
    
  </tbody>
</table>



## Enums



<h3 id="enum:ContactMethod">Enum <code>ContactMethod</code></h3>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>CONTACT_METHOD_OTHER</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CONTACT_METHOD_EMAIL</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CONTACT_METHOD_PHONE</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>




<h3 id="enum:ContactType">Enum <code>ContactType</code></h3>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>CONTACT_TYPE_OTHER</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CONTACT_TYPE_ABUSE</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CONTACT_TYPE_BILLING</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CONTACT_TYPE_TECHNICAL</code></td>
      <td><code>3</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>




<h3 id="enum:GrantType">Enum <code>GrantType</code></h3>
<p>The OAuth2 flows an OAuth client can use to get an access token.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>GRANT_AUTHORIZATION_CODE</code></td>
      <td><code>0</code></td>
      <td> Grant type used to exchange an authorization code for an access token.</td>
    </tr>
    <tr>
      <td><code>GRANT_PASSWORD</code></td>
      <td><code>1</code></td>
      <td> Grant type used to exchange a user ID and password for an access token.</td>
    </tr>
    <tr>
      <td><code>GRANT_REFRESH_TOKEN</code></td>
      <td><code>2</code></td>
      <td> Grant type used to exchange a refresh token for an access token.</td>
    </tr>
  </tbody>
</table>




<h3 id="enum:State">Enum <code>State</code></h3>
<p>State enum defines states that an entity can be in.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>STATE_REQUESTED</code></td>
      <td><code>0</code></td>
      <td> Denotes that the entity has been requested and is pending review by an admin.</td>
    </tr>
    <tr>
      <td><code>STATE_APPROVED</code></td>
      <td><code>1</code></td>
      <td> Denotes that the entity has been reviewed and approved by an admin.</td>
    </tr>
    <tr>
      <td><code>STATE_REJECTED</code></td>
      <td><code>2</code></td>
      <td> Denotes that the entity has been reviewed and rejected by an admin.</td>
    </tr>
    <tr>
      <td><code>STATE_FLAGGED</code></td>
      <td><code>3</code></td>
      <td> Denotes that the entity has been flagged and is pending review by an admin.</td>
    </tr>
    <tr>
      <td><code>STATE_SUSPENDED</code></td>
      <td><code>4</code></td>
      <td> Denotes that the entity has been reviewed and suspended by an admin.</td>
    </tr>
  </tbody>
</table>




<h3 id="enum:Right">Enum <code>Right</code></h3>
<p>Right is the enum that defines all the different rights to do something in the network.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>right_invalid</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_INFO</code></td>
      <td><code>1</code></td>
      <td> The right to view user information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_SETTINGS_BASIC</code></td>
      <td><code>2</code></td>
      <td> The right to edit basic user settings.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_LIST</code></td>
      <td><code>87</code></td>
      <td> The right to list users accounts.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_CREATE</code></td>
      <td><code>88</code></td>
      <td> The right to create an user account.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_SETTINGS_API_KEYS</code></td>
      <td><code>3</code></td>
      <td> The right to view and edit user API keys.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_DELETE</code></td>
      <td><code>4</code></td>
      <td> The right to delete user account.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_PURGE</code></td>
      <td><code>66</code></td>
      <td> The right to purge user account.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_AUTHORIZED_CLIENTS</code></td>
      <td><code>5</code></td>
      <td> The right to view and edit authorized OAuth clients of the user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_APPLICATIONS_LIST</code></td>
      <td><code>6</code></td>
      <td> The right to list applications the user is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_APPLICATIONS_CREATE</code></td>
      <td><code>7</code></td>
      <td> The right to create an application under the user account.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_GATEWAYS_LIST</code></td>
      <td><code>8</code></td>
      <td> The right to list gateways the user is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_GATEWAYS_CREATE</code></td>
      <td><code>9</code></td>
      <td> The right to create a gateway under the account of the user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_CLIENTS_LIST</code></td>
      <td><code>10</code></td>
      <td> The right to list OAuth clients the user is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_CLIENTS_CREATE</code></td>
      <td><code>11</code></td>
      <td> The right to create an OAuth client under the account of the user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_ORGANIZATIONS_LIST</code></td>
      <td><code>12</code></td>
      <td> The right to list organizations the user is a member of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_ORGANIZATIONS_CREATE</code></td>
      <td><code>13</code></td>
      <td> The right to create an organization under the user account.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_NOTIFICATIONS_READ</code></td>
      <td><code>59</code></td>
      <td> The right to read notifications sent to the user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_USER_ALL</code></td>
      <td><code>14</code></td>
      <td> The pseudo-right for all (current and future) user rights.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_INFO</code></td>
      <td><code>15</code></td>
      <td> The right to view application information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_SETTINGS_BASIC</code></td>
      <td><code>16</code></td>
      <td> The right to edit basic application settings.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_SETTINGS_API_KEYS</code></td>
      <td><code>17</code></td>
      <td> The right to view and edit application API keys.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_SETTINGS_COLLABORATORS</code></td>
      <td><code>18</code></td>
      <td> The right to view and edit application collaborators.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_SETTINGS_PACKAGES</code></td>
      <td><code>56</code></td>
      <td> The right to view and edit application packages and associations.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_DELETE</code></td>
      <td><code>19</code></td>
      <td> The right to delete application.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_PURGE</code></td>
      <td><code>64</code></td>
      <td> The right to purge application.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_DEVICES_READ</code></td>
      <td><code>20</code></td>
      <td> The right to view devices in application.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_DEVICES_WRITE</code></td>
      <td><code>21</code></td>
      <td> The right to create devices in application.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_DEVICES_READ_KEYS</code></td>
      <td><code>22</code></td>
      <td> The right to view device keys in application.
Note that keys may not be stored in a way that supports viewing them.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_DEVICES_WRITE_KEYS</code></td>
      <td><code>23</code></td>
      <td> The right to edit device keys in application.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_TRAFFIC_READ</code></td>
      <td><code>24</code></td>
      <td> The right to read application traffic (uplink and downlink).</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_TRAFFIC_UP_WRITE</code></td>
      <td><code>25</code></td>
      <td> The right to write uplink application traffic.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE</code></td>
      <td><code>26</code></td>
      <td> The right to write downlink application traffic.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_LINK</code></td>
      <td><code>27</code></td>
      <td> The right to link as Application to a Network Server for traffic exchange,
i.e. read uplink and write downlink (API keys only).
This right is typically only given to an Application Server.
This right implies RIGHT_APPLICATION_INFO, RIGHT_APPLICATION_TRAFFIC_READ,
and RIGHT_APPLICATION_TRAFFIC_DOWN_WRITE.</td>
    </tr>
    <tr>
      <td><code>RIGHT_APPLICATION_ALL</code></td>
      <td><code>28</code></td>
      <td> The pseudo-right for all (current and future) application rights.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_ALL</code></td>
      <td><code>29</code></td>
      <td> The pseudo-right for all (current and future) OAuth client rights.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_INFO</code></td>
      <td><code>60</code></td>
      <td> The right to read client information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_SETTINGS_BASIC</code></td>
      <td><code>61</code></td>
      <td> The right to edit basic client settings.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_SETTINGS_COLLABORATORS</code></td>
      <td><code>62</code></td>
      <td> The right to view and edit client collaborators.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_DELETE</code></td>
      <td><code>63</code></td>
      <td> The right to delete a client.</td>
    </tr>
    <tr>
      <td><code>RIGHT_CLIENT_PURGE</code></td>
      <td><code>68</code></td>
      <td> The right to purge a client.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_INFO</code></td>
      <td><code>30</code></td>
      <td> The right to view gateway information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_SETTINGS_BASIC</code></td>
      <td><code>31</code></td>
      <td> The right to edit basic gateway settings.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_SETTINGS_API_KEYS</code></td>
      <td><code>32</code></td>
      <td> The right to view and edit gateway API keys.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_SETTINGS_COLLABORATORS</code></td>
      <td><code>33</code></td>
      <td> The right to view and edit gateway collaborators.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_DELETE</code></td>
      <td><code>34</code></td>
      <td> The right to delete gateway.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_PURGE</code></td>
      <td><code>67</code></td>
      <td> The right to purge gateway.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_TRAFFIC_READ</code></td>
      <td><code>35</code></td>
      <td> The right to read gateway traffic.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_TRAFFIC_DOWN_WRITE</code></td>
      <td><code>36</code></td>
      <td> The right to write downlink gateway traffic.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_LINK</code></td>
      <td><code>37</code></td>
      <td> The right to link as Gateway to a Gateway Server for traffic exchange,
i.e. write uplink and read downlink (API keys only)
This right is typically only given to a gateway.
This right implies RIGHT_GATEWAY_INFO.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_STATUS_READ</code></td>
      <td><code>38</code></td>
      <td> The right to view gateway status.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_LOCATION_READ</code></td>
      <td><code>39</code></td>
      <td> The right to view view gateway location.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_WRITE_SECRETS</code></td>
      <td><code>57</code></td>
      <td> The right to store secrets associated with this gateway.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_READ_SECRETS</code></td>
      <td><code>58</code></td>
      <td> The right to retrieve secrets associated with this gateway.</td>
    </tr>
    <tr>
      <td><code>RIGHT_GATEWAY_ALL</code></td>
      <td><code>40</code></td>
      <td> The pseudo-right for all (current and future) gateway rights.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_INFO</code></td>
      <td><code>41</code></td>
      <td> The right to view organization information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_SETTINGS_BASIC</code></td>
      <td><code>42</code></td>
      <td> The right to edit basic organization settings.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_SETTINGS_API_KEYS</code></td>
      <td><code>43</code></td>
      <td> The right to view and edit organization API keys.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_SETTINGS_MEMBERS</code></td>
      <td><code>44</code></td>
      <td> The right to view and edit organization members.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_DELETE</code></td>
      <td><code>45</code></td>
      <td> The right to delete organization.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_PURGE</code></td>
      <td><code>65</code></td>
      <td> The right to purge organization.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_APPLICATIONS_LIST</code></td>
      <td><code>46</code></td>
      <td> The right to list the applications the organization is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_APPLICATIONS_CREATE</code></td>
      <td><code>47</code></td>
      <td> The right to create an application under the organization.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_GATEWAYS_LIST</code></td>
      <td><code>48</code></td>
      <td> The right to list the gateways the organization is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_GATEWAYS_CREATE</code></td>
      <td><code>49</code></td>
      <td> The right to create a gateway under the organization.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_CLIENTS_LIST</code></td>
      <td><code>50</code></td>
      <td> The right to list the OAuth clients the organization is a collaborator of.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_CLIENTS_CREATE</code></td>
      <td><code>51</code></td>
      <td> The right to create an OAuth client under the organization.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_ADD_AS_COLLABORATOR</code></td>
      <td><code>52</code></td>
      <td> The right to add the organization as a collaborator on an existing entity.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ORGANIZATION_ALL</code></td>
      <td><code>53</code></td>
      <td> The pseudo-right for all (current and future) organization rights.</td>
    </tr>
    <tr>
      <td><code>RIGHT_SEND_INVITES</code></td>
      <td><code>54</code></td>
      <td> The right to send invites to new users.
Note that this is not prefixed with &ldquo;USER_&rdquo;; it is not a right on the user entity.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_PROFILE_CREATE</code></td>
      <td><code>69</code></td>
      <td> The right to create an alert notification profile.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_PROFILE_INFO</code></td>
      <td><code>70</code></td>
      <td> The right to view an alert notification profile information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_PROFILE_LIST</code></td>
      <td><code>71</code></td>
      <td> The right to list the alert notification profiles.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_PROFILE_UPDATE</code></td>
      <td><code>72</code></td>
      <td> The right to update an alert notification profiles.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_PROFILE_DELETE</code></td>
      <td><code>73</code></td>
      <td> The right to delete an alert notification profiles.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_RECEIVER_CREATE</code></td>
      <td><code>74</code></td>
      <td> The right to create an alert notification receiver.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_RECEIVER_INFO</code></td>
      <td><code>75</code></td>
      <td> The right to view an alert notification receiver information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_RECEIVER_LIST</code></td>
      <td><code>76</code></td>
      <td> The right to list the alert notification receivers.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_RECEIVER_UPDATE</code></td>
      <td><code>77</code></td>
      <td> The right to update an alert notification receivers.</td>
    </tr>
    <tr>
      <td><code>RIGHT_ALERT_NOTIFICATION_RECEIVER_DELETE</code></td>
      <td><code>78</code></td>
      <td> The right to delete an alert notification receivers.</td>
    </tr>
    <tr>
      <td><code>RIGHT_AUTHENTICATION_PROVIDER_CREATE</code></td>
      <td><code>79</code></td>
      <td> The right to create an authentication provider.</td>
    </tr>
    <tr>
      <td><code>RIGHT_AUTHENTICATION_PROVIDER_INFO</code></td>
      <td><code>80</code></td>
      <td> The right to view an authentication provider information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_AUTHENTICATION_PROVIDER_LIST</code></td>
      <td><code>81</code></td>
      <td> The right to list the authentication providers</td>
    </tr>
    <tr>
      <td><code>RIGHT_AUTHENTICATION_PROVIDER_UPDATE</code></td>
      <td><code>82</code></td>
      <td> The right to update an authentication providers.</td>
    </tr>
    <tr>
      <td><code>RIGHT_AUTHENTICATION_PROVIDER_DELETE</code></td>
      <td><code>83</code></td>
      <td> The right to delete an authentication providers.</td>
    </tr>
    <tr>
      <td><code>RIGHT_EXTERNAL_USER_CREATE</code></td>
      <td><code>84</code></td>
      <td> The right to create an external user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_EXTERNAL_USER_INFO</code></td>
      <td><code>85</code></td>
      <td> The right to view an external user&rsquo;s information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_EXTERNAL_USER_DELETE</code></td>
      <td><code>86</code></td>
      <td> The right to delete an external user.</td>
    </tr>
    <tr>
      <td><code>RIGHT_PACKET_BROKER_AGENT_READ</code></td>
      <td><code>89</code></td>
      <td> The right to read any information related to the PBA.</td>
    </tr>
    <tr>
      <td><code>RIGHT_PACKET_BROKER_AGENT_WRITE</code></td>
      <td><code>90</code></td>
      <td> The right to perform operations in the PBA.</td>
    </tr>
    <tr>
      <td><code>RIGHT_TENANT_CONFIGURATION_UPDATE</code></td>
      <td><code>91</code></td>
      <td> The right to update a tenant&rsquo;s configuration.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_CREATE</code></td>
      <td><code>92</code></td>
      <td> The right to create a label.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_INFO</code></td>
      <td><code>93</code></td>
      <td> The right to view a label&rsquo;s information.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABELS_LIST</code></td>
      <td><code>94</code></td>
      <td> The right to list the labels.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_UPDATE</code></td>
      <td><code>95</code></td>
      <td> The right to update a label.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_DELETE</code></td>
      <td><code>96</code></td>
      <td> The right to delete a label.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_ASSIGN</code></td>
      <td><code>97</code></td>
      <td> The right to assign a label to an entity.</td>
    </tr>
    <tr>
      <td><code>RIGHT_LABEL_ALL</code></td>
      <td><code>99</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>RIGHT_ALL</code></td>
      <td><code>55</code></td>
      <td> The pseudo-right for all (current and future) possible rights.</td>
    </tr>
  </tbody>
</table>






	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	


