Skip to main content
POST
ArchivePrincipalAttributeEnumValue

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

archivedEnumValueId
string
required

Body

application/json
replacementEnumValueId
string

When the archived_enum_value_id is archived all principal attribute values that reference it will be migrated to the replacement_enum_value_id if provided. Otherwise, user-attributes that reference it will be archived as well.

Response

A successful response.

principalAttributeValuesMigrated
integer<int32>

Total number of principal attribute values migrated or archived by this operation. When a replacement enum value is provided, this represents values migrated to the new value. When no replacement is provided, this represents values that were archived.