Update

Update a user attribute mapping by its mapping ID. The display name and app user profile attribute key are derived from attribute_type. Profile type bindings are updated only when update_mask contains profile_type_ids.

PUT /api/v1/user-attribute-mappings/{id}

Update

cURL

curl --request PUT \
  --url https://{tenantDomain}.conductor.one/api/v1/user-attribute-mappings/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributeType": {
    "id": "<string>",
    "app": {
      "appId": "<string>"
    },
    "appUserProfile": {
      "appId": "<string>",
      "appUserProfileAttributeKey": "<string>"
    },
    "celExpression": {
      "celExpression": "<string>",
      "userProfileAttributeKey": "<string>"
    },
    "customAppUserProfile": {
      "appId": "<string>",
      "appUserProfileAttributeKey": "<string>",
      "userProfileAttributeKey": "<string>"
    },
    "displayName": "<string>"
  },
  "expandMask": {
    "paths": [
      "<string>"
    ]
  },
  "fallbacks": [
    {
      "app": {
        "appId": "<string>"
      },
      "appUserProfile": {
        "appId": "<string>",
        "appUserProfileAttributeKey": "<string>"
      },
      "celExpression": {
        "celExpression": "<string>",
        "userProfileAttributeKey": "<string>"
      }
    }
  ],
  "profileTypeIds": [
    "<string>"
  ],
  "updateMask": "<string>"
}
'

200

{
  "attribute": {
    "appPath": "<string>",
    "fallbacksPath": "<string>",
    "userAttributeMapping": {
      "appId": "<string>",
      "appUserProfileAttributeKey": "<string>",
      "attributeType": {
        "id": "<string>",
        "app": {
          "appId": "<string>"
        },
        "appUserProfile": {
          "appId": "<string>",
          "appUserProfileAttributeKey": "<string>"
        },
        "celExpression": {
          "celExpression": "<string>",
          "userProfileAttributeKey": "<string>"
        },
        "customAppUserProfile": {
          "appId": "<string>",
          "appUserProfileAttributeKey": "<string>",
          "userProfileAttributeKey": "<string>"
        },
        "displayName": "<string>"
      },
      "count": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "displayName": "<string>",
      "evaluationErrorCount": 123,
      "fallbacks": [
        {
          "app": {
            "appId": "<string>"
          },
          "appUserProfile": {
            "appId": "<string>",
            "appUserProfileAttributeKey": "<string>"
          },
          "celExpression": {
            "celExpression": "<string>",
            "userProfileAttributeKey": "<string>"
          }
        }
      ],
      "id": "<string>",
      "priority": 123,
      "profileTypeIds": [
        "<string>"
      ],
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  },
  "expanded": [
    {
      "@type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

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

Authorization · string · header · required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

id · string · required

The id field.

Body

application/json

The UserAttributeManagementServiceUpdateRequest message.

attributeType · User Attribute Type · object | null · required

The UserAttributeType message.

This message contains a oneof named config. Only a single field of the following list may be set at a time:

• app
• appUserProfile
• customAppUserProfile
• celExpression

Show child attributes

expandMask · User Attribute Map Config Expand Mask · object | null

The UserAttributeMapConfigExpandMask message.

Show child attributes

fallbacks · User Attribute Mapping Fallback · object[] | null

The fallbacks field.

Show child attributes

profileTypeIds · string[] | null

The profileTypeIds field.

updateMask · string | null

Response

200 - application/json

Successful response

The UserAttributeManagementServiceUpdateResponse message.

attribute · User Attribute Mapping View · object | null

The UserAttributeMappingView message.

Show child attributes

expanded · object[] | null

The expanded field.

Show child attributes