Skip to main content

Get Identity Attribute

GET 

/identity-attributes/:name

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This gets an identity attribute for a given technical name.

Request

Path Parameters

    name stringrequired

    The attribute's technical name.

    Example: displayName

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses

The identity attribute with the given name

Schema

    name stringrequired

    Identity attribute's technical name.

    displayName string

    Identity attribute's business-friendly name.

    standard boolean

    Indicates whether the attribute is 'standard' or 'default'.

    type stringnullable

    Identity attribute's type.

    multi boolean

    Indicates whether the identity attribute is multi-valued.

    searchable boolean

    Indicates whether the identity attribute is searchable.

    system boolean

    Indicates whether the identity attribute is 'system', meaning that it doesn't have a source and isn't configurable.

    sources

    object[]

    Identity attribute's list of sources - this specifies how the rule's value is derived.

  • Array [

  • type string

    Attribute mapping type.

    properties object

    Attribute mapping properties.

  • ]

Loading...