Modifies selected properties of an attribute

patch https://{tenanturl}/v1.0/attributes/{attrId}

Modifies the attribute with the specified ID for this tenant.
Unlike the PUT API, the request body for PATCH does not need to be the full attribute model but instead should only contain the properties of the attribute that need to be updated.

Entitlements required: manageAttributes.

Path Params

attrId

string

required

attribute identifier

Body Params

Attribute Payload

name

string

The human-readable name of the attribute. Maximum length is 2048 characters

description

string

The description of the attribute. Maximum length is 2048 characters

sourceType

string

The type of the attribute source from which the attribute value is derived

datatype

string

The type of derived data that is expected for the attribute. Defaults to string

tags

value

string

The default value of the attribute. This value also refers to the fixed value for sourceType="static". Maximum length is 2048 characters

credName

string

The name of the attribute in the login session credentials. Maximum length is 2048 characters

credNameOverrides

object

Realm specific name of the attribute in the login session credentials. This property is specified in the form of key-value pairs where the key is the name of the realm and the value is the name of the attribute used to override the 'credName' property. Maximum length is 2048 characters

function

object

customProperties

object

Identifies the attribute custom properties that is attached to this attribute. These custom properties can be any user-defined key-value pairs that help identify or categorize the attribute. The maximum number of custom properties that can be defined is 25

Headers

Authorization

string

required

Authorization Header

Responses

204

No content

Language

URL


xxxxxxxxxx
1
curl --request PATCH \
2
     --url https://tenant_url/v1.0/attributes/attrId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: */*'

Choose an example:

application/json

400Bad request

404No resource found

500Internal server error