Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

Lookup Credential Token

POST
/iam/v1/users:lookupCredentialToken
 
curl --request POST \
  --url https://example.com/iam/v1/users:lookupCredentialToken \
  --header 'Content-Type: application/json' \
  --data '{ "credential_token": "example" }'

Resolves a live single-use credential token to the identity behind it and says which KIND of token it is, so a client holding a bare token can show the right page — an activation link and a recovery link are indistinguishable as strings.

Anonymous and read-only: it never consumes the token. POST rather than GET so the token travels in the body and never lands in an access log, a proxy’s request line, or a browser history entry.

Request Body required

Section titled “Request Body required ”
Media type application/json

LookupCredentialTokenRequest

Request message for LookupCredentialToken.

object
credential_token
required

The one-time credential token to resolve, of either kind. Not consumed by this call.

string
Example generated
{
  "credential_token": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json

LookupCredentialTokenResponse

The identity behind a live credential token, and which kind of token it is.

Full identity is deliberate: whoever holds the token IS the person, so masking their own email would protect nothing while making the confirmation screen useless. Every dead token answers NOT_FOUND uniformly, so the response is never an oracle for which tokens once existed.

object
email

The person’s email address.

stringOutput only
name

The person’s given name.

stringOutput only
surname

The person’s family name.

stringOutput only
expire_time

When the token stops being usable.

string format: date-time Output only
type

Which kind of token this is, and therefore which redemption call accepts it: ACTIVATION for :activate, PASSWORD_RESET for :completePasswordReset.

string format: enum Output only
Allowed values: CREDENTIAL_TOKEN_TYPE_UNSPECIFIED CREDENTIAL_TOKEN_TYPE_ACTIVATION CREDENTIAL_TOKEN_TYPE_PASSWORD_RESET
Example 
{
  "type": "CREDENTIAL_TOKEN_TYPE_UNSPECIFIED"
}

default

Section titled “default ”

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}