principal_attributes

Services

RPC methods exposed by this API.

PrincipalAttributeService

Messages

Data models used across requests/responses.

ArchivePrincipalAttributeEnumValueRequest

Field	Type	Label	Description
archived_enum_value_id	string
replacement_enum_value_id	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.

ArchivePrincipalAttributeEnumValueResponse

Field	Type	Label	Description
principal_attribute_values_migrated	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.

ArchivePrincipalAttributeKeysRequest

ArchivePrincipalAttributeKeysRequest is used to batch archive principal attribute keys by id.

Field	Type	Label	Description
principal_attribute_key_ids	string	repeated

ArchivePrincipalAttributeKeysResponse

This message has no fields.

ArchivePrincipalAttributeValuesRequest

ArchivePrincipalAttributeValuesRequest is used to batch archive principal attribute values by id.

Field	Type	Label	Description
principal_attribute_value_ids	string	repeated
principal_type	PrincipalAttributePrincipalType

ArchivePrincipalAttributeValuesResponse

This message has no fields.

BatchArchivePrincipalAttributeEnumValuesRequest

Field	Type	Label	Description
archival_requests	BatchArchivePrincipalAttributeEnumValuesRequest.EnumValueArchival	repeated

BatchArchivePrincipalAttributeEnumValuesRequest.EnumValueArchival

Field	Type	Label	Description
archived_enum_value_id	string		The enum value ID to archive.
replacement_enum_value_id	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.

BatchArchivePrincipalAttributeEnumValuesResponse

Field	Type	Label	Description
total_principal_attribute_values_migrated	int32		Total number of principal attribute values migrated or archived across all enum value operations. This includes both values migrated to replacement values and values archived without replacement.

BatchCreatePrincipalAttributeValueRequest

BatchCreatePrincipalAttributeValueRequest is used to batch create new principal attribute values.

Field	Type	Label	Description
principal_attribute_key_id	string
principal_ids	string	repeated
principal_type	PrincipalAttributePrincipalType
oneof value. principal_attribute_enum_value_id	string		For ENUM type: exactly one enum value ID.
oneof value. principal_attribute_enum_value_ids	PrincipalAttributeEnumValueIdList		For SET_OF_ENUM type: one or more enum value IDs representing the complete desired set. Omitted enum values that are currently active for each principal+key will be archived.
oneof value. number_value	int64
oneof value. boolean_value	bool

BatchCreatePrincipalAttributeValueResponse

BatchCreatePrincipalAttributeValueResponse returns the principal attribute values from a BatchCreatePrincipalAttributeValue call.

Field	Type	Label	Description
principal_attribute_values	PrincipalAttributeValue	repeated

BatchUnarchivePrincipalAttributeEnumValuesRequest

Field	Type	Label	Description
principal_attribute_enum_value_ids	string	repeated

BatchUnarchivePrincipalAttributeEnumValuesResponse

This message has no fields.

CheckPrincipalAttributeKeyArchiveImpactRequest

Field	Type	Label	Description
principal_attribute_key_id	string

CheckPrincipalAttributeKeyArchiveImpactResponse

Field	Type	Label	Description
active_user_principal_attribute_value_count	int64		Non-archived user principal-attribute value rows for this key that will be archived with the key (same scope as ArchivePrincipalAttributeKeys; includes multiple rows per principal for SET_OF_ENUM).
active_user_group_principal_attribute_value_count	int64		Non-archived user_group_attribute_values rows for this key. They are not archived by ArchivePrincipalAttributeKeys, but stop contributing to principal.groupAttributes once the key is archived (evaluation joins active keys only).

CreatePrincipalAttributeEnumValueRequest

Principal Attribute Enum Value RPC messages

Field	Type	Label	Description
principal_attribute_key_id	string
display_name	string
description	string

CreatePrincipalAttributeEnumValueResponse

Field	Type	Label	Description
principal_attribute_enum_value	PrincipalAttributeEnumValue

CreatePrincipalAttributeKeyRequest

CreatePrincipalAttributeKeyRequest is used to create a new principal attribute key.

Field	Type	Label	Description
display_name	string
description	string
type	PrincipalAttributeValueType
initial_enum_values	CreatePrincipalAttributeKeyRequest.InitialEnumValue	repeated	Optional initial enum values to create alongside the key. Only applicable for ENUM type keys.

CreatePrincipalAttributeKeyRequest.InitialEnumValue

Nested message for initial enum values in create requests.

Field	Type	Label	Description
display_name	string
description	string

CreatePrincipalAttributeKeyResponse

CreatePrincipalAttributeKeyResponse returns the principal attribute key from a CreatePrincipalAttributeKey call.

Field	Type	Label	Description
principal_attribute_key	PrincipalAttributeKey
enum_values	PrincipalAttributeEnumValue	repeated	The enum values created alongside the key, if any were provided in the request.

GetPrincipalAttributeEnumValueRequest

Field	Type	Label	Description
principal_attribute_enum_value_id	string

GetPrincipalAttributeEnumValueResponse

Field	Type	Label	Description
principal_attribute_enum_value	PrincipalAttributeEnumValue

GetPrincipalAttributeKeyRequest

GetPrincipalAttributeKeyRequest is used to retrieve a principal attribute key.

Field	Type	Label	Description
principal_attribute_key_id	string

GetPrincipalAttributeKeyResponse

GetPrincipalAttributeKeyResponse returns a principal attribute key from a GetPrincipalAttributeKey call.

Field	Type	Label	Description
principal_attribute_key	PrincipalAttributeKey

GetPrincipalAttributeValueRequest

GetPrincipalAttributeValueRequest is used to retrieve a principal attribute value.

Field	Type	Label	Description
principal_attribute_value_id	string
principal_type	PrincipalAttributePrincipalType

GetPrincipalAttributeValueResponse

GetPrincipalAttributeValueResponse returns a principal attribute value from a GetPrincipalAttributeValue call.

Field	Type	Label	Description
principal_attribute_value	PrincipalAttributeValue

ListPrincipalAttributeEnumValuesRequest

Field	Type	Description
principal_attribute_key_id	string
page_size	uint32	The maximum number of enum values to return. The service may return fewer than this value. If unspecified, at most 50 enum values will be returned. The maximum value is 100; values above 100 will be coerced to 100.
page_token	string	A page token, received from a previous `ListPrincipalAttributeEnumValues` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListPrincipalAttributeEnumValues` must match the call that provided the page token.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are `principal_attribute_enum_value_id`, `name`, `display_name`, `description`, `created_by_user_id`, `modified_by_user_id`, `created_date`, and `modified_date`. Archive state is controlled via the `include_archived` field below, not via filter. For further information about how to use CELs, please refer to this guide.
order_by	string	How to order the retrieved enum values. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date`, `modified_date`, and `display_name`. If left empty, items are ordered by `created_date` in descending order (newest-first). For more information about the format of this field, read this Example: “display_name,created_date desc”
include_archived	bool	Whether to include archived enum values. Defaults to false.

ListPrincipalAttributeEnumValuesResponse

Field	Type	Label	Description
principal_attribute_enum_values	PrincipalAttributeEnumValue	repeated
next_page_token	string

ListPrincipalAttributeKeyValuesRequest

ListPrincipalAttributeKeyValuesRequest is used to list principal attribute values for a given principal attribute key with the provided filter.

Field	Type	Description
principal_attribute_key_id	string	The id of the principal attribute key to list values for.
principal_type	PrincipalAttributePrincipalType
page_size	uint32	The maximum number of principal attribute values to return. The service may return fewer than this value. If unspecified, at most 50 principal attribute values will be returned. The maximum value is 1000. Values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListPrincipalAttributeKeyValues` call. Provide this to retrieve a subsequent page of principal attribute values. When paginating, all other parameters provided to `ListPrincipalAttributeKeyValues` must match the previous call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are: ‘principal_attribute_value_id’, ‘principal_attribute_key_id’, ‘principal_attribute_enum_value_id’, ‘number_value’, ‘boolean_value’, ‘created_date’, ‘created_by_user_id’, ‘principal_id’, and ‘principal_type’ For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by	string	How to order the retrieved principal attribute values. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date` If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read this Example: “created_date desc”
include_archived	bool	If true, include archived values. Defaults to false. Optional.

ListPrincipalAttributeKeyValuesResponse

ListPrincipalAttributeKeyValuesResponse returns the list of principal attribute values from a ListPrincipalAttributeKeyValues call.

Field	Type	Label	Description
principal_attribute_values	PrincipalAttributeValue	repeated
next_page_token	string

ListPrincipalAttributeKeysRequest

ListPrincipalAttributeKeysRequest is used to list principal attribute keys with the provided filter.

Field	Type	Description
page_size	uint32	The maximum number of principal attribute keys to return. The service may return fewer than this value. If unspecified, at most 50 principal attribute keys will be returned. The maximum value is 1000. Values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListPrincipalAttributeKeys` call. Provide this to retrieve a subsequent page of principal attribute keys. When paginating, all other parameters provided to `ListPrincipalAttributeKeys` must match the previous call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are: ‘principal_attribute_key_id’, ‘display_name’, ‘value_type’, ‘created_by_user_id’, ‘created_date’, ‘modified_by_user_id, ‘modified_date’ For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by	string	How to order the retrieved principal attribute keys. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date`, ‘modified_date’, ‘display_name’, ‘principal_attribute_key_id’, ‘value_type’, ‘description’ If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date”
organization_id	string
include_archived	bool	If true, includes archived keys. Defaulta to false. Optional.

ListPrincipalAttributeKeysResponse

ListPrincipalAttributeKeysResponse returns the list of principal attribute keys from a ListPrincipalAttributeKeys call.

Field	Type	Label	Description
principal_attribute_keys	PrincipalAttributeKey	repeated
next_page_token	string

ListPrincipalAttributeValuesRequest

ListPrincipalAttributeValuesRequest is used to list principal attribute values with the provided filter.

Field	Type	Description
principal_type	PrincipalAttributePrincipalType
page_size	uint32	The maximum number of principal attribute values to return. The service may return fewer than this value. If unspecified, at most 50 principal attribute values will be returned. The maximum value is 1000. Values above 1000 will be coerced to 1000. Optional.
page_token	string	A page token, received from a previous `ListPrincipalAttributeValues` call. Provide this to retrieve a subsequent page of principal attribute values. When paginating, all other parameters provided to `ListPrincipalAttributeValues` must match the previous call that provided the page token. Optional.
filter	string	A Common Expression Language (CEL) filter string. Available fields to filter by are: ‘principal_attribute_value_id’, ‘principal_attribute_key_id’, ‘principal_attribute_enum_value_id’, ‘number_value’, ‘boolean_value’, ‘created_date’, ‘created_by_user_id’, ‘principal_id’, and ‘principal_type’. Archive state is controlled via the `include_archived` field below, not via filter. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.
order_by	string	How to order the retrieved principal attribute values. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are `created_date` If left empty, items are ordered by `created_date` in ascending order (oldest-first). For more information about the format of this field, read this Example: “created_date desc”
include_archived	bool	If true, include archived values. Defaults to false. Optional.

ListPrincipalAttributeValuesResponse

ListPrincipalAttributeValuesResponse returns the list of principal attribute values from a ListPrincipalAttributeValues call.

Field	Type	Label	Description
principal_attribute_values	PrincipalAttributeValue	repeated
next_page_token	string

PrincipalAttributeEnumValue

Represents a possible enumerable value for ENUM type principal attribute keys. Users can add new enum values as needed.

Field	Type	Description
principal_attribute_enum_value_id	string
principal_attribute_key_id	string
display_name	string
description	string
created_date	google.protobuf.Timestamp
created_by_user_id	string
modified_date	google.protobuf.Timestamp
modified_by_user_id	string
archived_date	google.protobuf.Timestamp
is_archived	bool	Whether or not the principal attribute enum value is archived. This is inferred from whether archived_date is set.

PrincipalAttributeEnumValueIdList

Field	Type	Label	Description
ids	string	repeated

PrincipalAttributeKey

Field	Type	Description
principal_attribute_key_id	string
organization_id	string
display_name	string
description	string
type	PrincipalAttributeValueType
created_date	google.protobuf.Timestamp
created_by_user_id	string
modified_date	google.protobuf.Timestamp
modified_by_user_id	string
archived_date	google.protobuf.Timestamp
is_archived	bool	Whether or not the principal attribute key is archived. This is inferred from whether archived_date is set.

PrincipalAttributeValue

Field	Type	Description
principal_attribute_value_id	string
principal_attribute_key_id	string
principal_id	string	The ID of the user or user group this value is assigned to.
principal_type	PrincipalAttributePrincipalType
organization_id	string
oneof value. principal_attribute_enum_value_id	string
oneof value. number_value	int64
oneof value. boolean_value	bool
created_by_user_id	string
created_date	google.protobuf.Timestamp
archived_date	google.protobuf.Timestamp
is_archived	bool	Whether or not the principal attribute value is archived. This is inferred from whether archived_date is set.
key	PrincipalAttributeKey	The full principal attribute key is populated in the response.
enum_value_details	PrincipalAttributeEnumValue	Populated in responses with full enum value details.

UnarchivePrincipalAttributeEnumValueRequest

Field	Type	Label	Description
principal_attribute_enum_value_id	string

UnarchivePrincipalAttributeEnumValueResponse

This message has no fields.

UnarchivePrincipalAttributeKeysRequest

UnarchivePrincipalAttributeKeysRequest is used to batch unarchive principal attribute keys by id.

Field	Type	Label	Description
principal_attribute_key_ids	string	repeated

UnarchivePrincipalAttributeKeysResponse

This message has no fields.

UnarchivePrincipalAttributeValuesRequest

UnarchivePrincipalAttributeValuesRequest is used to batch unarchive principal attribute values by id.

Field	Type	Label	Description
principal_attribute_value_ids	string	repeated
principal_type	PrincipalAttributePrincipalType

UnarchivePrincipalAttributeValuesResponse

This message has no fields.

UpdatePrincipalAttributeEnumValueRequest

Field	Type	Description
principal_attribute_enum_value_id	string
display_name	string
description	string
update_mask	google.protobuf.FieldMask	The list of fields to be updated. The fields available to be updated are `description` and `archived_date`.

UpdatePrincipalAttributeEnumValueResponse

Field	Type	Label	Description
principal_attribute_enum_value	PrincipalAttributeEnumValue

UpdatePrincipalAttributeKeyRequest

UpdatePrincipalAttributeKeyRequest is used to update an existing principal attribute key.

Field	Type	Description
principal_attribute_key_id	string
display_name	string
description	string
update_mask	google.protobuf.FieldMask	The list of fields to be updated. The fields available to be updated are ‘description’.

UpdatePrincipalAttributeKeyResponse

UpdatePrincipalAttributeKeyResponse returns the principal attribute key from a UpdatePrincipalAttributeKey call.

Field	Type	Label	Description
principal_attribute_key	PrincipalAttributeKey

Enums

Allowed constant values used in message fields.

PrincipalAttributePrincipalType

PrincipalAttributePrincipalType enumerates the supported principal types for principal attribute values.

Name	Number	Description
PRINCIPAL_ATTRIBUTE_PRINCIPAL_TYPE_UNSPECIFIED	0
PRINCIPAL_ATTRIBUTE_PRINCIPAL_TYPE_USER	1
PRINCIPAL_ATTRIBUTE_PRINCIPAL_TYPE_USER_GROUP	2

PrincipalAttributeValueType

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

Name	Number	Description
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_UNSPECIFIED	0
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_ENUM	1
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_BOOLEAN	2
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_NUMBER	3
PRINCIPAL_ATTRIBUTE_VALUE_TYPE_SET_OF_ENUM	4

⌘I

Method	Request	Response	Description
CreatePrincipalAttributeKey	CreatePrincipalAttributeKeyRequest	CreatePrincipalAttributeKeyResponse	Creates a principal attribute key.
GetPrincipalAttributeKey	GetPrincipalAttributeKeyRequest	GetPrincipalAttributeKeyResponse	Retrieves a principal attribute key.
ListPrincipalAttributeKeys	ListPrincipalAttributeKeysRequest	ListPrincipalAttributeKeysResponse	Lists principal attribute keys, respecting the provided filter.
UpdatePrincipalAttributeKey	UpdatePrincipalAttributeKeyRequest	UpdatePrincipalAttributeKeyResponse	Updates an existing principal attribute key.
CheckPrincipalAttributeKeyArchiveImpact	CheckPrincipalAttributeKeyArchiveImpactRequest	CheckPrincipalAttributeKeyArchiveImpactResponse
ArchivePrincipalAttributeKeys	ArchivePrincipalAttributeKeysRequest	ArchivePrincipalAttributeKeysResponse	Batch archives principal attribute keys AND all their associated principal attribute values.
UnarchivePrincipalAttributeKeys	UnarchivePrincipalAttributeKeysRequest	UnarchivePrincipalAttributeKeysResponse	Batch unarchives principal attribute keys.
BatchCreatePrincipalAttributeValue	BatchCreatePrincipalAttributeValueRequest	BatchCreatePrincipalAttributeValueResponse	Creates a principal attribute value for multiple principals in a single operation.
GetPrincipalAttributeValue	GetPrincipalAttributeValueRequest	GetPrincipalAttributeValueResponse	Retrieves a principal attribute value.
ListPrincipalAttributeKeyValues	ListPrincipalAttributeKeyValuesRequest	ListPrincipalAttributeKeyValuesResponse	Lists principal attribute values for a given principal attribute key, respecting the provided filter.
ListPrincipalAttributeValues	ListPrincipalAttributeValuesRequest	ListPrincipalAttributeValuesResponse	Lists principal attribute values, respecting the provided filter.
ArchivePrincipalAttributeValues	ArchivePrincipalAttributeValuesRequest	ArchivePrincipalAttributeValuesResponse	Batch archives principal attribute values.
UnarchivePrincipalAttributeValues	UnarchivePrincipalAttributeValuesRequest	UnarchivePrincipalAttributeValuesResponse	Batch unarchives principal attribute values.
CreatePrincipalAttributeEnumValue	CreatePrincipalAttributeEnumValueRequest	CreatePrincipalAttributeEnumValueResponse	Creates a principal attribute enum value.
GetPrincipalAttributeEnumValue	GetPrincipalAttributeEnumValueRequest	GetPrincipalAttributeEnumValueResponse	Retrieves a principal attribute enum value.
ListPrincipalAttributeEnumValues	ListPrincipalAttributeEnumValuesRequest	ListPrincipalAttributeEnumValuesResponse	Lists principal attribute enum values for a given principal attribute key.
UpdatePrincipalAttributeEnumValue	UpdatePrincipalAttributeEnumValueRequest	UpdatePrincipalAttributeEnumValueResponse	Updates an existing principal attribute enum value.
ArchivePrincipalAttributeEnumValue	ArchivePrincipalAttributeEnumValueRequest	ArchivePrincipalAttributeEnumValueResponse	Archives a principal attribute enum value and migrates all principal attribute values with that enum value to a replacement enum value.
UnarchivePrincipalAttributeEnumValue	UnarchivePrincipalAttributeEnumValueRequest	UnarchivePrincipalAttributeEnumValueResponse	Unarchives a principal attribute enum value BUT DOES NOT migrate principal attribute values with a replacement value back to the original value.
BatchArchivePrincipalAttributeEnumValues	BatchArchivePrincipalAttributeEnumValuesRequest	BatchArchivePrincipalAttributeEnumValuesResponse	Archives multiple principal attribute enum values and migrates all principal attribute values with those enum values to their respective replacement enum values.
BatchUnarchivePrincipalAttributeEnumValues	BatchUnarchivePrincipalAttributeEnumValuesRequest	BatchUnarchivePrincipalAttributeEnumValuesResponse	Unarchives multiple principal attribute enum values BUT DOES NOT migrate principal attribute values with a replacement value back to the original value.

​Services