Get User Attribute Profiles

Retrieve a list of User Attribute Profiles. This endpoint supports Checkpoint pagination.

GET https://{tenantDomain}/api/v2/user-attribute-profiles

Get User Attribute Profiles

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/user-attribute-profiles \
  --header 'Authorization: Bearer <token>'

200

{
  "next": "<string>",
  "user_attribute_profiles": [
    {
      "id": "<string>",
      "name": "<string>",
      "user_id": {
        "oidc_mapping": "sub",
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>",
        "strategy_overrides": {
          "pingfederate": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "ad": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "adfs": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "waad": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "google-apps": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "okta": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "oidc": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          },
          "samlp": {
            "oidc_mapping": "sub",
            "saml_mapping": [
              "<string>"
            ],
            "scim_mapping": "<string>"
          }
        }
      },
      "user_attributes": {}
    }
  ]
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 5.

Required range: x >= 1

Response

200

application/json

User Attribute Profiles successfully retrieved.

next · string

A cursor to be used as the "from" query parameter for the next page of results.

user_attribute_profiles · object[]

Show child attributes