Modifies an attribute

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

Modifies the attribute with the specified ID for this tenant.

Entitlements required: manageAttributes.

Path Params

attrId

string

required

attribute identifier

Body Params

Attribute Payload

string

The unique identifier for the attribute

name

string

required

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

description

string

The description of the attribute. Maximum length is 2048 characters

scope

string

Identifies whether the attribute is defined globally by the system or specific to the tenant

sourceType

string

required

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

datatype

string

required

The type of derived data that is expected for the attribute. Defaults to string. The integer datatype is used for any numerical value.

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

schemaAttribute

object

profileAttribute

object

constraints

object

function

object

customProperties

object

Identifies the attribute custom properties that are attached to this attribute

Headers

Authorization

string

required

Authorization Header

Responses

204

No content

Language

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://tenant_url/v1.0/attributes/attrId \
3
     --header 'accept: application/json' \
4
     --header 'content-type: */*' \
5
     --data '{"sourceType":"static","datatype":"string","schemaAttribute":{"customAttribute":true}}'

Choose an example:

application/json

400Bad request

404No resource found

500Internal server error