Get User Attribute Profile Template

Retrieve a User Attribute Profile Template.

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

Get User Attribute Profile Template

cURL

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

200

{
  "id": "<string>",
  "display_name": "<string>",
  "template": {
    "name": "<string>",
    "user_id": {
      "saml_mapping": [
        "<string>"
      ],
      "scim_mapping": "<string>",
      "strategy_overrides": {
        "pingfederate": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "ad": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "adfs": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "waad": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "google-apps": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "okta": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "oidc": {
          "saml_mapping": [
            "<string>"
          ],
          "scim_mapping": "<string>"
        },
        "samlp": {
          "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.

Path Parameters

id · string · required

ID of the user-attribute-profile-template to retrieve.

Response

200

application/json

User Attribute Profile Template successfully retrieved.

id · string

The id of the template.

display_name · string

The user-friendly name of the template displayed in the UI.

template · object

The structure of the template, which can be used as the payload for creating or updating a User Attribute Profile.

Show child attributes