---
title: "Gets the metadata to describe the claims/fields used by authentication providers that support identities."
method: GET
path: "/users/identity-metadata"
tags: ["Users"]
---

# Gets the metadata to describe the claims/fields used by authentication providers that support identities.

`GET /users/identity-metadata`

## Response `200`

The user identity metadata

- GetUserIdentityMetadataResponse
  - `Links` object, required
  - `Providers` IdentityMetadataResource[], required
    - `ClaimDescriptors` ClaimDescriptor[]
      - `Description` string
      - `IsIdentifyingClaim` boolean
      - `Label` string
      - `Type` string
    - `IdentityProviderName` string
    - `Links` object
    - `ScimEnabled` boolean

## Other responses

- `400` — Bad request. Either the payload was not structurally valid or business rules did not permit the operation.
- `404` — Not found. One or more of the entities involved in the operation was not found.

---

[API](https://skmtc.net/octopus/apis/octopus-server-api.md) · [All operations](https://skmtc.net/octopus/apis/octopus-server-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/octopus/octopus-server-api/versions/bc9158facfc7/schema)