The Client Identifier endpoint and fields are described below including details of the supported RESTful CRUD verbs. For details of the conventions of the API see the general conventions.
Endpoint path prefix:
/n/v1/clientidentifier
clientidentifier was introduced in API version V1
Client Identifier has not been marked for deprecation
Client identifiers (deduplication keys) are used to store domain scoped IDs associated with an identity. These can be used to support linking an identity across multiple systems.
This endpoint supports the following CRUD operations in line with our API conventions. See the conventions section for more details.
Client Identifier reference
{
"identity" : {
"urn" : "10615807-513a-49b5-85e4-9df44a0e1ef1",
"url" : "/n/v1/identity/10615807-513a-49b5-85e4-9df44a0e1ef1"
},
"domain" : "example.com",
"token" : "1234567"
}Client Identifier reference
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.
{
"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"
}API code CREATE_SUCCESS HTTP status code 201 : When the representation provided was successfully created return HTTP created (201). Note that when other context like authorisation and permissions are satisfied but the representation is invalid or missing required information typically a error representation with details of the missing information may be returned instead with REPRESENTATION_MISSING_REQUIRED_FIELD api error for example
API code REPRESENTATION_MISSING_REQUIRED_FIELD HTTP status code 400 : When creating or updating a representation the provided representation was missing a required filed. Typically has a error response representation with details of the missing required field.
API code INVALID_REPRESENTATION HTTP status code 400 : When creating or updating a representation and the provided representation is invalid. May include an error representation with details of the issue
Client Identifier
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.
{
"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"
}API code READ_SUCCESS HTTP status code 200 : On read when the request is successful. The returned representation is given with the relevant 2XX HTTP code without further detail.
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.
Client Identifier
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.
{
"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"
}API code UPDATE_SUCCESS HTTP status code 202 : When creation was successful and the representation was created. Returns HTTP accepted (202) response and typically includes the representation of the created representation for reference. Note that CREATE / UPDATE can trigger async operations after the representation is accepted which can update state.
API code INVALID_REPRESENTATION HTTP status code 400 : When creating or updating a representation and the provided representation is invalid. May include an error representation with details of the issue
API code REPRESENTATION_MISSING_REQUIRED_FIELD HTTP status code 400 : When creating or updating a representation the provided representation was missing a required filed. Typically has a error response representation with details of the missing required field.
API code DELETE_SUCCESS HTTP status code 202 : When deletion of a representation was successful. Note that returns HTTP accepted (202) to represent the success of the deletion state transfer rather than HTTP gone (410) as 4XX represent client errors for semantic consistency
API code NOT_FOUND HTTP status code 404 : When the request referenced a representation or a concept that was not found including other request context requirements. Note that if a request is missing other concepts including authorisation, permissions or restrictions on the visibility HTTP not found (404) will typically be returned. Note that when creating a representation if the owner or other references can't be resolved the endpoint may return not found.