LinkedIdentity

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTCreate Linked Identity/api/v1/users/{user}/linkedIdentities
• GETGet Linked Identity/api/v1/users/{user}/linkedIdentities/{linkedIdentity}

Referenced by these component schemas:

• ListLinkedIdentitiesResponse

Shape and fields

object

LinkedIdentity represents an SSO identity linked to a user account.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name of the linked identity.\n Format: users/{user}/linkedIdentities/{linked_identity}"
    },
    "idpName": {
      "readOnly": true,
      "type": "string",
      "description": "The resource name of the identity provider.\n Format: identity-providers/{idp}"
    },
    "externUid": {
      "readOnly": true,
      "type": "string",
      "description": "The external user identifier from the identity provider."
    }
  },
  "description": "LinkedIdentity represents an SSO identity linked to a user account."
}