Skip to main content
POST
CreatePrincipalAttributeKey

Authorizations

Authorization
string
header
required

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

Body

application/json

CreatePrincipalAttributeKeyRequest is used to create a new principal attribute key.

CreatePrincipalAttributeKeyRequest is used to create a new principal attribute key.

displayName
string
required
type
enum<string>
default:PRINCIPAL_ATTRIBUTE_VALUE_TYPE_UNSPECIFIED
required

PrincipalAttributeValueType enumerates the supported value types for a principal attribute key.

Available options:
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_UNSPECIFIED,
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_ENUM,
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_BOOLEAN,
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_NUMBER,
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_SET_OF_ENUM
description
string
initialEnumValues
object[]

Optional initial enum values to create alongside the key. Only applicable for ENUM type keys.

Response

A successful response.

CreatePrincipalAttributeKeyResponse returns the principal attribute key from a CreatePrincipalAttributeKey call.

principalAttributeKey
object
required
enumValues
object[]

The enum values created alongside the key, if any were provided in the request.