Gets an attribute

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

Retrieves the attribute with the specified ID for this tenant.

Entitlements required: readAttributes, manageAttributes.

Responses

Response body

object

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

static credential schema profile

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.

string boolean integer string[] integer[]

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

Has additional fields

schemaAttribute

object

name

string

required

The unique name for the attribute in the Cloud Directory schema. For custom schema attributes, the names are predefined and named customAttribute1 through customAttribute150

attributeName

string

required

The attribute name in the schema that is associated with the attribute source

scimName

string

required

The SCIM name that is associated with the schema attribute

customAttribute

boolean

required

The flag that indicates whether this is a custom attribute

profileAttribute

object

name

string

required

The name of the attribute in the application profile.

constraints

object

readAccessForEndUser

boolean

writeAccessForEndUser

boolean

mandatory

boolean

unique

boolean

valueConstraint

object

valueConstraintFormat

string

valueConstraintType

string

function

object

name

string

The function name

custom

string

The custom function

customProperties

object

Identifies the attribute custom properties that are attached to this attribute

Has additional fields

Language

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://tenant_url/v1.0/attributes/attrId \
3
     --header 'accept: application/json'

Choose an example:

application/json

200Successful Query

400Bad request

404No resource found

500Internal server error