Skip to main content

Update Identity Attribute

PUT 

/identity-attributes/:name

This updates an existing identity attribute. Making an attribute searchable requires that the system, standard, and multi properties be set to false.

Request

Path Parameters

    name stringrequired

    The attribute's technical name.

    Example: displayName

Body

required
    name string

    The technical name of the identity attribute

    displayName string

    The business-friendly name of the identity attribute

    standard boolean

    Default value: false

    Shows if the attribute is 'standard' or default

    type string

    The type of the identity attribute

    multi boolean

    Default value: false

    Shows if the identity attribute is multi-valued

    searchable boolean

    Default value: false

    Shows if the identity attribute is searchable

    system boolean

    Default value: false

    Shows this is 'system' identity attribute that does not have a source and is not configurable.

    sources object[]

    List of sources for an attribute, this specifies how the value of the rule is derived

  • Array [
  • type string

    The type of the source

    properties object

    The source properties

  • ]

Responses

The identity attribute was updated successfully

Schema
    name string

    The technical name of the identity attribute

    displayName string

    The business-friendly name of the identity attribute

    standard boolean

    Default value: false

    Shows if the attribute is 'standard' or default

    type string

    The type of the identity attribute

    multi boolean

    Default value: false

    Shows if the identity attribute is multi-valued

    searchable boolean

    Default value: false

    Shows if the identity attribute is searchable

    system boolean

    Default value: false

    Shows this is 'system' identity attribute that does not have a source and is not configurable.

    sources object[]

    List of sources for an attribute, this specifies how the value of the rule is derived

  • Array [
  • type string

    The type of the source

    properties object

    The source properties

  • ]
Loading...