HomeUse CasesConceptsConfig GuidesDeveloper GuidesAPI Reference
API Reference

Creates an attribute

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

Creates a custom attribute for this tenant.

Entitlements required: manageAttributes.

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

LoadingLoading

Body Params

Attribute Payload

string

The unique identifier for the attribute

string
required

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

string

The description of the attribute. Maximum length is 2048 characters

string

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

string
enum
required

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

Allowed:
string
enum
required

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

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

schemaAttribute
object
profileAttribute
object
constraints
object
function
object
customProperties
object

Identifies the attribute custom properties that are attached to this attribute

Headers
string
required

Authorization Header

Responses
201

Created

Updated over 2 years ago

Language
URL
LoadingLoading

Response
Choose an example:
application/json

Updated over 2 years ago