# User APIs

> List of User APIs.

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


List of User APIs.

## The `UserRegistry` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Create</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Register a new user. This method may be restricted by network settings.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateUserRequest"><code>CreateUserRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:User"><code>User</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/users</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Get</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Get the user with the given identifiers, selecting the fields given by the
field mask. The method may return more or less fields, depending on the rights
of the caller.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetUserRequest"><code>GetUserRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:User"><code>User</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/users/{user_ids.user_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.List</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List users of the network. This method is typically restricted to admins only.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListUsersRequest"><code>ListUsersRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Users"><code>Users</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/users</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Update</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Update the user, changing the fields specified by the field mask to the provided values.
This method can not be used to change the password, see the UpdatePassword method for that.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UpdateUserRequest"><code>UpdateUserRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:User"><code>User</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>PUT</code> <code>/api/v3/users/{user.ids.user_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Delete</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Delete the user. This may not release the user ID for reuse.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UserIdentifiers"><code>UserIdentifiers</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/users/{user_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Restore</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        <p>Restore a recently deleted user.</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:UserIdentifiers"><code>UserIdentifiers</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/users/{user_id}/restore</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.Purge</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Purge the user. This will release the user ID for reuse.
The user is responsible for clearing data from any (external) integrations
that may store and expose data by user or organization ID.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UserIdentifiers"><code>UserIdentifiers</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/users/{user_id}/purge</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.UpdatePassword</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Update the password of the user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UpdateUserPasswordRequest"><code>UpdateUserPasswordRequest</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/users/{user_ids.user_id}/password</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserRegistry.CreateTemporaryPassword</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Create a temporary password that can be used for updating a forgotten password.
The generated password is sent to the user&rsquo;s email address.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateTemporaryPasswordRequest"><code>CreateTemporaryPasswordRequest</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/users/{user_ids.user_id}/temporary_password</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `ExternalUserRegistry` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ExternalUserRegistry.Create</code>
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateExternalUserRequest"><code>CreateExternalUserRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:ExternalUser"><code>ExternalUser</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/authentication_providers/{external_user.provider_ids.provider_id}/external_users</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ExternalUserRegistry.GetByUserID</code>
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetExternalUserByUserIDRequest"><code>GetExternalUserByUserIDRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:ExternalUser"><code>ExternalUser</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/authentication_providers/{provider_ids.provider_id}/users/{user_ids.user_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ExternalUserRegistry.GetByExternalID</code>
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetExternalUserByExternalIDRequest"><code>GetExternalUserByExternalIDRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:ExternalUser"><code>ExternalUser</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/authentication_providers/{provider_ids.provider_id}/external_users/{external_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>ExternalUserRegistry.Delete</code>
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:DeleteExternalUserRequest"><code>DeleteExternalUserRequest</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/authentication_providers/{provider_ids.provider_id}/external_users/{external_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `EntityRegistrySearch` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>EntityRegistrySearch.SearchUsers</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Search for users that match the conditions specified in the request.
This is only available to admin users.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:SearchUsersRequest"><code>SearchUsersRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Users"><code>Users</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/search/users</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `UserAccess` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.ListRights</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the rights the caller has on this user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UserIdentifiers"><code>UserIdentifiers</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/users/{user_id}/rights</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.CreateAPIKey</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Create an API key scoped to this user.
User API keys can give access to the user itself, as well as
any organization, application, gateway and OAuth client this user is a collaborator of.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateUserAPIKeyRequest"><code>CreateUserAPIKeyRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:APIKey"><code>APIKey</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/users/{user_ids.user_id}/api-keys</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.DeleteAPIKey</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Delete a single API key of this user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:DeleteUserAPIKeyRequest"><code>DeleteUserAPIKeyRequest</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/users/{user_ids.user_id}/api-keys/{key_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.ListAPIKeys</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the API keys for this user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListUserAPIKeysRequest"><code>ListUserAPIKeysRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:APIKeys"><code>APIKeys</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/users/{user_ids.user_id}/api-keys</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.GetAPIKey</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Get a single API key of this user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:GetUserAPIKeyRequest"><code>GetUserAPIKeyRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:APIKey"><code>APIKey</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/users/{user_ids.user_id}/api-keys/{key_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.UpdateAPIKey</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Update the rights of an API key of the user.
This method can also be used to delete the API key, by giving it 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:UpdateUserAPIKeyRequest"><code>UpdateUserAPIKeyRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:APIKey"><code>APIKey</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>PUT</code> <code>/api/v3/users/{user_ids.user_id}/api-keys/{api_key.id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserAccess.CreateLoginToken</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Create a login token that can be used for a one-time login as a user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateLoginTokenRequest"><code>CreateLoginTokenRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:CreateLoginTokenResponse"><code>CreateLoginTokenResponse</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/users/{user_ids.user_id}/login-tokens</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `UserInvitationRegistry` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserInvitationRegistry.Send</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Invite a user to join the network.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:SendInvitationRequest"><code>SendInvitationRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Invitation"><code>Invitation</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>POST</code> <code>/api/v3/invitations</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserInvitationRegistry.List</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the invitations the caller has sent.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListInvitationsRequest"><code>ListInvitationsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:Invitations"><code>Invitations</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/invitations</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserInvitationRegistry.Delete</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Delete (revoke) a user invitation.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:DeleteInvitationRequest"><code>DeleteInvitationRequest</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/invitations</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `UserSessionRegistry` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserSessionRegistry.Delete</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Delete (revoke) the given user session.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UserSessionIdentifiers"><code>UserSessionIdentifiers</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/users/{user_ids.user_id}/sessions/{session_id}</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>UserSessionRegistry.List</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the active sessions for the given user.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListUserSessionsRequest"><code>ListUserSessionsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:UserSessions"><code>UserSessions</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
        <p><code>GET</code> <code>/api/v3/users/{user_ids.user_id}/sessions</code></p>
      </td>
    </tr>
  </tbody>
</table>


## The `NotificationService` service




<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>NotificationService.Create</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Create a new notification. Can only be called by internal services using cluster auth.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:CreateNotificationRequest"><code>CreateNotificationRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:CreateNotificationResponse"><code>CreateNotificationResponse</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        HTTP bindings
      </th>
      <td>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>NotificationService.List</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        List the notifications for a user or an organization.
When called with user credentials and empty receiver_ids, this will list
notifications for the current user and its organizations.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:ListNotificationsRequest"><code>ListNotificationsRequest</code></a>
        
      </td>
    </tr>
    <tr>
      <th>
        Response type
      </th>
      <td>
        <a href="#message:ListNotificationsResponse"><code>ListNotificationsResponse</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/users/{receiver_ids.user_id}/notifications</code></p>
      </td>
    </tr>
  </tbody>
</table>





<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Method
      </th>
      <td>
        <code>NotificationService.UpdateStatus</code>
      </td>
    </tr>
    <tr>
      <th>
        Description
      </th>
      <td>
        Batch-update multiple notifications to the same status.
      </td>
    </tr>
    <tr>
      <th>
        Request type
      </th>
      <td>
        <a href="#message:UpdateNotificationStatusRequest"><code>UpdateNotificationStatusRequest</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>PATCH</code> <code>/api/v3/users/{receiver_ids.user_id}/notifications</code></p>
      </td>
    </tr>
  </tbody>
</table>


## Messages


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

<details><summary>Show object example</summary>
<pre><code>{
  "id": "",
  "key": "",
  "name": "",
  "rights": [],
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "expires_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>id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Immutable and unique public identifier for the API key.
Generated by the Access Server.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>key</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Immutable and unique secret value of the API key.
Generated by the Access Server.</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>User-defined (friendly) name for the API key.</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>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 that are granted to this API key.</p>
            <p><code>defined_only</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>
    
  </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>
    
  </tbody>
</table>

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




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

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

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




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>application_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:AuthenticationProviderIdentifiers">Message <code>AuthenticationProviderIdentifiers</code></h3>

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>provider_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: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:CreateUserAPIKeyRequest">Message <code>CreateUserAPIKeyRequest</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "user_ids": {},
  "name": "",
  "rights": [],
  "expires_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>user_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </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>name</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <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>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>min_items</code>: <code>1</code></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>expires_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>gt_now</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:CreateLoginTokenRequest">Message <code>CreateLoginTokenRequest</code></h3>

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

<p><b>Fields:</b></p>
<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>
    
    <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>skip_email</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Skip sending the login token to the user by email.
This field is only effective when the login token is created by an admin user.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
  </tbody>
</table>




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

<details><summary>Show object example</summary>
<pre><code>{
  "entity_ids": {},
  "notification_type": "",
  "data": null,
  "sender_ids": {},
  "receivers": [],
  "email": false,
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>entity_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:EntityIdentifiers">
  
  <code>
    
    EntityIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The entity this notification is about.</p>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>notification_type</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The type of this notification.</p>
          <p><code>in</code>: <code>[unknown api_key_created api_key_changed client_requested collaborator_changed entity_state_changed invitation login_token password_changed temporary_password user_requested validate support_access_requested]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>data</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Any
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The data related to the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>sender_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>If the notification was triggered by a user action, this contains the identifiers of the user that triggered the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>receivers</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:NotificationReceiver">
  
  <code>
  
  NotificationReceiver
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Receivers of the notification.</p>
          <p><code>min_items</code>: <code>1</code></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>email</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Whether an email should be sent for the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:User">
  
  <code>
    
    User
  </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>invitation_token</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The invitation token that was sent to the user (some networks require an invitation in order to register new users).</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

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




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

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

<p><b>Fields:</b></p>
<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><code>email</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>key_id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>provider_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:AuthenticationProviderIdentifiers">
  
  <code>
    
    AuthenticationProviderIdentifiers
  </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>external_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>250</code></p>
          <p><code>min_len</code>: <code>1</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:EmailNotificationPreferences">Message <code>EmailNotificationPreferences</code></h3>
<p>EmailNotificationPreferences is the message that defines the types of notifications for which the user wants to receive an email.</p>

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

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




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

<details><summary>Show object example</summary>
<pre><code>{
  "device_id": "",
  "application_ids": {},
  "dev_eui": "",
  "join_eui": "",
  "dev_addr": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>device_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>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>application_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ApplicationIdentifiers">
  
  <code>
    
    ApplicationIdentifiers
  </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>dev_eui</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bytes</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The LoRaWAN DevEUI.</p>
          <p><code>ignore_empty</code></p>
          <p><code>len</code>: <code>8</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>join_eui</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bytes</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The LoRaWAN JoinEUI (AppEUI until LoRaWAN 1.0.3 end devices).</p>
          <p><code>ignore_empty</code></p>
          <p><code>len</code>: <code>8</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>dev_addr</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bytes</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The LoRaWAN DevAddr.</p>
          <p><code>ignore_empty</code></p>
          <p><code>len</code>: <code>4</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:EntityIdentifiers">Message <code>EntityIdentifiers</code></h3>
<p>EntityIdentifiers contains one of the possible entity identifiers.</p>
<b>Restrictions:</b>
<ul>
  <li>Only one of <code>application_ids</code>, <code>client_ids</code>, <code>device_ids</code>, <code>gateway_ids</code>, <code>organization_ids</code>, <code>user_ids</code> can be set.</li>
</ul>

<details><summary>Show object example</summary>
<pre><code>{
  "application_ids": {},
  "client_ids": {},
  "device_ids": {},
  "gateway_ids": {},
  "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>application_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:ApplicationIdentifiers">
  
  <code>
    
    ApplicationIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<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>
    
  </tbody>
</table>

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

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

<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:GatewayIdentifiers">Message <code>GatewayIdentifiers</code></h3>

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>gateway_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>

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




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>key_id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Unique public identifier for the API key.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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>
    
    <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 user fields that should be returned.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>provider_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:AuthenticationProviderIdentifiers">
  
  <code>
    
    AuthenticationProviderIdentifiers
  </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>user_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      ttn.lorawan.v3.
    
    UserIdentifiers
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>provider_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:AuthenticationProviderIdentifiers">
  
  <code>
    
    AuthenticationProviderIdentifiers
  </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>external_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>250</code></p>
          <p><code>min_len</code>: <code>1</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

<details><summary>Show object example</summary>
<pre><code>{
  "email": "",
  "token": "",
  "expires_at": "0001-01-01T00:00:00Z",
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "accepted_at": "0001-01-01T00:00:00Z",
  "accepted_by": {},
}</code></pre>
</details>

<p><b>Fields:</b></p>
<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><code>email</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>expires_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</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>
    
  </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>
    
  </tbody>
</table>

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

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




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

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

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




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

<details><summary>Show object example</summary>
<pre><code>{
  "receiver_ids": {},
  "status": [],
  "limit": 0,
  "page": 0,
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>receiver_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The IDs of the receiving user.</p>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>status</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:NotificationStatus">
  
  <code>
  
  NotificationStatus
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Select notifications with these statuses.
An empty list is interpreted as &ldquo;all&rdquo;.</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>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>




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

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

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




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

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

<p><b>Fields:</b></p>
<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>




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>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.
Default ordering is by ID. Prepend with a minus (-) to reverse the order.</p>
          <p><code>in</code>: <code>[ api_key_id -api_key_id name -name created_at -created_at expires_at -expires_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>




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

<details><summary>Show object example</summary>
<pre><code>{
  "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>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 user 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>[ user_id -user_id name -name primary_email_address -primary_email_address state -state admin -admin 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 users.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>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>[ 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>




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

<details><summary>Show object example</summary>
<pre><code>{
  "id": "",
  "created_at": "0001-01-01T00:00:00Z",
  "entity_ids": {},
  "notification_type": "",
  "data": null,
  "sender_ids": {},
  "receivers": [],
  "email": false,
  "status": "NOTIFICATION_STATUS_UNSEEN",
  "status_updated_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>id</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The immutable ID of the notification. Generated by the server.</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>The time when the notification was triggered.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>entity_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:EntityIdentifiers">
  
  <code>
    
    EntityIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The entity this notification is about.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>notification_type</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The type of this notification.
TODO: Replace with type NotificationType in v4 <a href="https://github.com/TheThingsNetwork/lorawan-stack/issues/7384">https://github.com/TheThingsNetwork/lorawan-stack/issues/7384</a>.</p>
          <p><code>in</code>: <code>[unknown api_key_created api_key_changed client_requested collaborator_changed entity_state_changed invitation login_token password_changed temporary_password user_requested validate support_access_requested]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>data</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Any
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The data related to the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>sender_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>If the notification was triggered by a user action, this contains the identifiers of the user that triggered the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>receivers</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
              
                
              
          
        
        repeated 
  
    
    <a href="#enum:NotificationReceiver">
  
  <code>
  
  NotificationReceiver
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Relation of the notification receiver to the entity.</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>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Whether an email was sent for the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>status</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:NotificationStatus">
  
  <code>
  
  NotificationStatus
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The status of the notification.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>status_updated_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The time when the notification status was updated.</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:Picture">Message <code>Picture</code></h3>

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>embedded</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:Picture.Embedded">
  
  <code>
    
    Picture.Embedded
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Embedded picture.
Omitted if there are external URLs available (in sizes).</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>sizes</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        map of 
  <code>uint32</code>
 to 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>URLs of the picture for different sizes, if available on a CDN.</p>
        
            <p><code>uri_ref</code> (value)</p>
        
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:Picture.Embedded">Message <code>Picture.Embedded</code></h3>

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>mime_type</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>MIME type of the picture.</p>
          <p><code>max_len</code>: <code>32</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>data</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bytes</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Picture data. A data URI can be constructed as follows:
<code>data:&lt;mime_type&gt;;base64,&lt;data&gt;</code>.</p>
          <p><code>max_len</code>: <code>8388608</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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:SearchUsersRequest">Message <code>SearchUsersRequest</code></h3>
<p>This message is used for finding users in the EntityRegistrySearch service.</p>

<details><summary>Show object example</summary>
<pre><code>{
  "query": "",
  "id_contains": "",
  "name_contains": "",
  "description_contains": "",
  "attributes_contain": {},
  "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 users 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 users 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 users 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 users 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 users 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>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 users 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>[ user_id -user_id name -name primary_email_address -primary_email_address state -state admin -admin 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 users.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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><code>email</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>receiver_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The IDs of the receiving user.</p>
          <p><code>required</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
          
        
        repeated 
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The IDs of the notifications to update the status of.</p>
          <p><code>max_items</code>: <code>1000</code></p>
          <p><code>min_items</code>: <code>1</code></p>
          <p><code>unique</code></p>
            <p><code>len</code>: <code>36</code></p>
        
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>status</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:NotificationStatus">
  
  <code>
  
  NotificationStatus
  </code>
    
  </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The status to set on the notifications.</p>
          <p><code>defined_only</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>api_key</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:APIKey">
  
  <code>
    
    APIKey
  </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 api key fields that should be updated.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

<details><summary>Show object example</summary>
<pre><code>{
  "user_ids": {},
  "new": "",
  "old": "",
  "revoke_all_access": false,
}</code></pre>
</details>

<p><b>Fields:</b></p>
<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>
    
    <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>new</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>max_len</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>revoke_all_access</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Revoke active sessions and access tokens of user if true. To be used if credentials are suspected to be compromised.</p>
      </td>
    </tr>
    
  </tbody>
</table>




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

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

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:User">
  
  <code>
    
    User
  </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 user fields that should be updated.</p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:User">Message <code>User</code></h3>
<p>User is the message that defines a user 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": [],
  "primary_email_address": "",
  "primary_email_address_validated_at": "0001-01-01T00:00:00Z",
  "password": "",
  "password_updated_at": "0001-01-01T00:00:00Z",
  "require_password_update": false,
  "state": "STATE_REQUESTED",
  "state_description": "",
  "admin": false,
  "temporary_password": "",
  "temporary_password_created_at": "0001-01-01T00:00:00Z",
  "temporary_password_expires_at": "0001-01-01T00:00:00Z",
  "profile_picture": {},
  "application_limit": null,
  "client_limit": null,
  "gateway_limit": null,
  "organization_limit": null,
  "console_preferences": {},
  "email_notification_preferences": {},
  "universal_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:UserIdentifiers">
  
  <code>
    
    UserIdentifiers
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The identifiers of the user. 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 user 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 user 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 user 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 user. 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 user. 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 users. Typically used 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 user. Typically used to indicate who to contact with security/billing questions about the user.
This field is deprecated.</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>primary_email_address</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Primary email address that can be used for logging in.
This address is not public, use contact_info for that.</p>
          <p><code>email</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>primary_email_address_validated_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>When the primary email address was validated. Note that email address validation is not required on all networks.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>password</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The password field is only considered when creating a user.
It is not returned on API calls, and can not be updated by updating the User.
See the UpdatePassword method of the UserRegistry service for more information.</p>
          <p><code>max_len</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>require_password_update</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>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 user.
This information is public and can be seen by any authenticated user in the network.
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>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>admin</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>bool</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>This user is an admin.
This information is public and can be seen by any authenticated user in the network.
This field can only be modified by other admins.</p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>temporary_password</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The temporary password can only be used to update a user&rsquo;s password; never returned on API calls.
It is not returned on API calls, and can not be updated by updating the User.
See the CreateTemporaryPassword method of the UserRegistry service for more information.</p>
          <p><code>max_len</code>: <code>1000</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

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

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>profile_picture</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:Picture">
  
  <code>
    
    Picture
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>A profile picture for the user.
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>application_limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    UInt64Value
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The maximum number of applications of the user.
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>client_limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    UInt64Value
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The maximum number of clients of the user.
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>gateway_limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    UInt64Value
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The maximum number of gateways of the user.
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>organization_limit</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    UInt64Value
  </code>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>The maximum number of organizations of the user.
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>console_preferences</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:UserConsolePreferences">
  
  <code>
    
    UserConsolePreferences
  </code>
  
    </a>
  
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p>Console preferences contains the user&rsquo;s preferences regarding the behavior of the Console.</p>
      </td>
    </tr>
    
  </tbody>
</table>

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>universal_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>Universal rights are capable of restricting the user&rsquo;s interactions with the API, be it an admin or not.</p>
        
      </td>
    </tr>
    
  </tbody>
</table>




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

<details><summary>Show object example</summary>
<pre><code>{
  "user_ids": {},
  "provider_ids": {},
  "created_at": "0001-01-01T00:00:00Z",
  "updated_at": "0001-01-01T00:00:00Z",
  "external_id": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      ttn.lorawan.v3.
    
    UserIdentifiers
  </code>
  
</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>provider_ids</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#message:AuthenticationProviderIdentifiers">
  
  <code>
    
    AuthenticationProviderIdentifiers
  </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>created_at</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
        
  
  <code>
    
      google.protobuf.
    
    Timestamp
  </code>
  
</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>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>external_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>250</code></p>
          <p><code>min_len</code>: <code>1</code></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>




<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>




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

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

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




<h3 id="message:UserConsolePreferences">Message <code>UserConsolePreferences</code></h3>
<p>UserConsolePreferences is the message that defines the user preferences for the Console.</p>

<details><summary>Show object example</summary>
<pre><code>{
  "console_theme": "CONSOLE_THEME_SYSTEM",
  "dashboard_layouts": {},
  "sort_by": {},
  "tutorials": {},
}</code></pre>
</details>

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

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

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

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




<h3 id="message:UserConsolePreferences.DashboardLayouts">Message <code>UserConsolePreferences.DashboardLayouts</code></h3>

<details><summary>Show object example</summary>
<pre><code>{
  "api_key": "DASHBOARD_LAYOUT_TABLE",
  "application": "DASHBOARD_LAYOUT_TABLE",
  "collaborator": "DASHBOARD_LAYOUT_TABLE",
  "end_device": "DASHBOARD_LAYOUT_TABLE",
  "gateway": "DASHBOARD_LAYOUT_TABLE",
  "organization": "DASHBOARD_LAYOUT_TABLE",
  "overview": "DASHBOARD_LAYOUT_TABLE",
  "user": "DASHBOARD_LAYOUT_TABLE",
}</code></pre>
</details>

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

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>application</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</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="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>end_device</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>gateway</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>organization</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>overview</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>user</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
            
              
            
        
  
    
    <a href="#enum:DashboardLayout">
  
  <code>
  
  DashboardLayout
  </code>
    
  </a>
  
</td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:UserConsolePreferences.SortBy">Message <code>UserConsolePreferences.SortBy</code></h3>
<p>SortBy defines the field to which the Console will sort the display of entities.</p>

<details><summary>Show object example</summary>
<pre><code>{
  "api_key": "",
  "application": "",
  "collaborator": "",
  "end_device": "",
  "gateway": "",
  "organization": "",
  "user": "",
}</code></pre>
</details>

<p><b>Fields:</b></p>
<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>api_key</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ api_key_id -api_key_id name -name created_at -created_at expires_at -expires_at]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>application</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ application_id -application_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>collaborator</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ id -id rights -rights]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>end_device</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ device_id -device_id join_eui -join_eui dev_eui -dev_eui name -name description -description created_at -created_at last_seen_at -last_seen_at]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>

<table class="api">
  <tbody>
    <tr>
      <th style="width: 150px">
        Field
      </th>
      <td>
        <code>gateway</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ gateway_id -gateway_id gateway_eui -gateway_eui 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>organization</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ organization_id -organization_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>user</code>
      </td>
    </tr>
    <tr>
      <th>
        Type
      </th>
      <td>
        
        
  <code>string</code>
</td>
    </tr>
    
    <tr>
      <th>
        Description
      </th>
      <td>
          <p><code>in</code>: <code>[ user_id -user_id name -name primary_email_address -primary_email_address state -state admin -admin created_at -created_at]</code></p>
      </td>
    </tr>
    
  </tbody>
</table>




<h3 id="message:UserConsolePreferences.Tutorials">Message <code>UserConsolePreferences.Tutorials</code></h3>

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

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




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

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

<p><b>Fields:</b></p>
<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>
    
    <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>session_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>64</code></p>
      </td>
    </tr>
    
  </tbody>
</table>



## Enums



<h3 id="enum:ConsoleTheme">Enum <code>ConsoleTheme</code></h3>
<p>ConsoleTheme is the theme of the Console.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>CONSOLE_THEME_SYSTEM</code></td>
      <td><code>0</code></td>
      <td> The user prefers the system mode.</td>
    </tr>
    <tr>
      <td><code>CONSOLE_THEME_LIGHT</code></td>
      <td><code>1</code></td>
      <td> The user prefers the light mode.</td>
    </tr>
    <tr>
      <td><code>CONSOLE_THEME_DARK</code></td>
      <td><code>2</code></td>
      <td> The user prefers the dark mode.</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: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:DashboardLayout">Enum <code>DashboardLayout</code></h3>
<p>DashboardLayout is a set of possible layout values to be used in the Console.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>DASHBOARD_LAYOUT_TABLE</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>DASHBOARD_LAYOUT_LIST</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>DASHBOARD_LAYOUT_GRID</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>




<h3 id="enum:NotificationStatus">Enum <code>NotificationStatus</code></h3>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>NOTIFICATION_STATUS_UNSEEN</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>NOTIFICATION_STATUS_SEEN</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>NOTIFICATION_STATUS_ARCHIVED</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>




<h3 id="enum:NotificationType">Enum <code>NotificationType</code></h3>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>UNKNOWN</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>API_KEY_CREATED</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>API_KEY_CHANGED</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>CLIENT_REQUESTED</code></td>
      <td><code>3</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>COLLABORATOR_CHANGED</code></td>
      <td><code>4</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>ENTITY_STATE_CHANGED</code></td>
      <td><code>5</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>INVITATION</code></td>
      <td><code>6</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>LOGIN_TOKEN</code></td>
      <td><code>7</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>PASSWORD_CHANGED</code></td>
      <td><code>8</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>TEMPORARY_PASSWORD</code></td>
      <td><code>9</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>USER_REQUESTED</code></td>
      <td><code>10</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>VALIDATE</code></td>
      <td><code>11</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>SUPPORT_ACCESS_REQUESTED</code></td>
      <td><code>12</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>




<h3 id="enum:NotificationReceiver">Enum <code>NotificationReceiver</code></h3>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>NOTIFICATION_RECEIVER_UNKNOWN</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>NOTIFICATION_RECEIVER_COLLABORATOR</code></td>
      <td><code>1</code></td>
      <td> Notification is received by collaborators of the entity.
If the collaborator is an organization, the notification is received by organization members.</td>
    </tr>
    <tr>
      <td><code>NOTIFICATION_RECEIVER_ADMINISTRATIVE_CONTACT</code></td>
      <td><code>3</code></td>
      <td> Notification is received by administrative contact of the entity.
If this is an organization, the notification is received by organization members.</td>
    </tr>
    <tr>
      <td><code>NOTIFICATION_RECEIVER_TECHNICAL_CONTACT</code></td>
      <td><code>4</code></td>
      <td> Notification is received by technical contact of the entity.
If this is an organization, the notification is received by organization members.</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>




<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:Tutorial">Enum <code>Tutorial</code></h3>
<p>Tutorial is a set of possible tutorials in the Console.</p>
<table class="api">
  <thead>
    <tr>
      <th>Name</th>
      <th>Value</th>
      <th>Description</th>
    </tr>
  </thead>
  <tbody>
    <tr>
      <td><code>TUTORIAL_UNKNOWN</code></td>
      <td><code>0</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>TUTORIAL_LIVE_DATA_SPLIT_VIEW</code></td>
      <td><code>1</code></td>
      <td> </td>
    </tr>
    <tr>
      <td><code>TUTORIAL_LORAWAN_STARTER_USER</code></td>
      <td><code>2</code></td>
      <td> </td>
    </tr>
  </tbody>
</table>






	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	

	


