Identity APIs

Identity Management APIs

Retrieve the user's digital identity profile.

get

This endpoint retrieves the personal information associated with a user's identity. It provides visibility into the user's customizable online presence, which is displayed to others. The information is accessible based on the context of the authenticated request.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: identity.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/me

HTTPcURLJavaScriptPython

GET /identities/me HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "schema_id": "text",
  "source": "text",
  "schema_url": "text",
  "organization_id": "text",
  "credentials": {
    "oidc": {
      "type": "text",
      "identifiers": [
        "text"
      ]
    },
    "password": {
      "type": "text",
      "config": {
        "password": "text"
      }
    }
  },
  "state": "text",
  "state_changed_at": "2025-12-16T22:10:48.638Z",
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "verifiable_addresses": [
    {
      "id": "text",
      "value": "text",
      "verified": true,
      "via": "text",
      "status": "text",
      "verified_at": "2025-12-16T22:10:48.638Z"
    }
  ],
  "recovery_addresses": [
    {
      "id": "text",
      "value": "text",
      "via": "text"
    }
  ],
  "metadata_public": {
    "picture": "text"
  },
  "metadata_admin": {
    "person_id": "text"
  }
}

Retrieve current user's demographic profile information

get

This endpoint provides the demographic details for the authenticated user. It is intended for personal use, ensuring that users can access their own profile information securely. The data returned is private and not accessible to other users.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/me/demographics

HTTPcURLJavaScriptPython

GET /identities/me/demographics HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "age": "_0_to_14",
  "income": "none",
  "gender": "male",
  "household": true,
  "relationship_status": "single",
  "parental_status": "parent"
}

Retrieve user profile information.

get

This endpoint provides access to the user's profile information, which is customizable and represents their online presence. The data returned is based on the user's identity context, ensuring appropriate visibility and relevance for the requesting party.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: identity.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/me/profile

HTTPcURLJavaScriptPython

GET /identities/me/profile HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "metadata_public": {
    "picture": "text"
  }
}

Retrieve public profile information for a user

get

This endpoint returns the public profile information of a user if it has been configured as public. Sensitive information is excluded to ensure privacy. This allows others to view the user's customizable online presence while maintaining security.

👤 User Credential: You must login and authenticate a user and use their access token to invoke this service. This will operate the action under the specified user.

🔒 Permission: identity.get is required in order for the call to succeed. You must configure permissions for the person or service calling this endpoint and add this permission to their identity.

Authorizations

authorizationCode

OAuth2clientCredentialsRequired

An OIDC service account that was authenticated.

Authorization URL: Token URL:

Path parameters

userIdstringRequired

Responses

200

OK

*/*

401

Unauthorized

*/*

get

/identities/public/{userId}/profile

HTTPcURLJavaScriptPython

GET /identities/public/{userId}/profile HTTP/1.1
Host: gateway.dev.klustr.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "traits": {
    "name": {
      "given_name": "text",
      "family_name": "text",
      "middle_name": "text"
    },
    "birthdate": "2025-12-16",
    "email": "text",
    "username": "text",
    "gender": "male",
    "citizenship": "text",
    "locale": "text"
  },
  "metadata_public": {
    "picture": "text"
  }
}