Client Identifier object representation

The clientidentifier object representation and fields are described below.

clientidentifier was introduced in API version V1

clientidentifier has not been marked for deprecation

Usages

Client Identifier

Description

Client identifiers are associated with identities and are typically used to uniquely identify a particular identity in the scope of a particular domain e.g. Google SignIn profile ID or other platform user identifier.

Example create representation

{
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "domain" : "example.com",
  "token" : "1234567"
}

Example response representation

{
  "urn" : "46dda35e-a362-4dc3-a20b-4f650df0926b",
  "url" : "/n/v1/clientidentifier46dda35e-a362-4dc3-a20b-4f650df0926b",
  "identity" : {
    "urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
    "url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
  },
  "domain" : "example.com",
  "token" : "1234567"
}

Fields

Name	Type	Description	Constraints
urn	String representation of a Unique Resource Name. Typically a UUID with 36 characters.	URN for this client identifier
url	URL represented as a string	URL to access this identifier
identity	identity	The identity this identifier is associated with
domain	Domain identifier used to scope values e.g. yourdomain.com	Domain of the identifier e.g. google.com	Required on create. Minimum length: 1.
token	String literal		Required on create. Minimum length: 1.
expires	Timestamp expressed in ISO 8601 format without timezone including milliseconds. Note unless otherwise stated in UTC zone.		Optional.