Skip to main content

Lookup User Public Key (v1)

This endpoint allows retrieval of a user's public key, it provides additional flexibility to third-party application developers by allowing querying via email, telephone, user identifier (both internal and external) and by complete identity (encrypted).

Queries against this endpoint are filtered by the third-party's user pool, in other words, this call will only return users belonging to the same application as specified in the auth token.

This endpoint accepts a single JSON key (multiple keys cannot be used) which can be one of the following:

FieldDescription
emailEmail address
telephoneE.164 formatted telephone
localKeySentry Interactive identifier for a user (UUID)
foreignKeyThird-party application's identifier for a user
identityEncrypted OpenID token of user

The first four query keys, email, telephone, localKey and foreignKey are read only - these will return a 404 error if the user is not known to Sentry Interactive.

The remaining query key, identity, is used to specify the full identity of the user who is the subject of the query, this will mean the user is created if they don't exist and will always return a response. When using identity, the specified OpenID token must be encrypted so it cannot be abused as an authentication token - it should be encrypted using JSON Web Encryption (JWE) using the RSA key Sentry Interactive generates for the particular third-party application.

Example

CURL
curl 'https://api.doordeck.com/directory/query' \
-X POST \
-H 'authorization: Bearer TOKEN' \
-H 'content-type: application/json' \
--data-binary '{"email":"USER_EMAIL"}'
Remember
  • Replace TOKEN with your access token.
  • Replace USER_EMAIL with the user's email.