HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Modifies selected properties of an attribute

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

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests

LoadingLoading

Path Params
string
required

attribute identifier

Body Params

Attribute Payload

string

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

string

The description of the attribute. Maximum length is 2048 characters

string
enum

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

Allowed:
string
enum

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

Allowed:
tags
array of strings

The tags used to categorize attributes. Maximum number of tags is 25

tags
string

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

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
string
required

Authorization Header

Responses
204

No content

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated over 2 years ago