Update an attribute

put

https://{tenant}/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}

You can update an attribute for an identity store by calling this endpoint. The attribute type, name, path and searchability cannot be altered.

REQUIRED API PERMISSION
write:config_identity_store

Path Params

identityStoreName

string

required

string

required

Body Params

connector

object

Represents the connector related configurations

displayName

string

required

length between 1 and 128

displayOnAdminConsole

boolean

Defaults to false

displayOnMyAccount

boolean

Defaults to false

displayOnOrganizationPortal

boolean

Defaults to false

displayOnRegistration

boolean

Defaults to false

editableOnAdminConsole

boolean

Defaults to false

editableOnMyAccount

boolean

Defaults to false

editableOnOrganizationPortal

boolean

Defaults to false

enabled

boolean

Defaults to false

frontendHook

object

required

Represents a frontend hook

string

required

indexing

string

enum

required

Defines searchability for an attribute. Possible values: none - Not searchable, searchOnly - Searchable, searchUnique - Searchable and unique to identity store, searchUniqueInOrganization - Searchable and unique to organization

Allowed:

name

string

required

length between 1 and 64

nativeClaim

object

path

string

length between 0 and 128

Default value is an empty string

required

boolean

Defaults to false

type

string

enum

required

default

boolean

Defaults to false

Headers

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

*/*

application/problem+json

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found