> ## Documentation Index
> Fetch the complete documentation index at: https://docs.siftstack.com/llms.txt
> Use this file to discover all available pages before exploring further.
# resource_attribute
> sift/resource_attribute/v1/resource_attribute.proto
## Services
*RPC methods exposed by this API.*
### ResourceAttributeService
| Method | Request | Response | Description |
| :---------------------------------------- | :---------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------------------------ | :---------------------------------------------------------------------------------------------------------------------------- |
| CreateResourceAttributeKey | [CreateResourceAttributeKeyRequest](#createresourceattributekeyrequest) | [CreateResourceAttributeKeyResponse](#createresourceattributekeyresponse) | |
| GetResourceAttributeKey | [GetResourceAttributeKeyRequest](#getresourceattributekeyrequest) | [GetResourceAttributeKeyResponse](#getresourceattributekeyresponse) | |
| ListResourceAttributeKeys | [ListResourceAttributeKeysRequest](#listresourceattributekeysrequest) | [ListResourceAttributeKeysResponse](#listresourceattributekeysresponse) | |
| UpdateResourceAttributeKey | [UpdateResourceAttributeKeyRequest](#updateresourceattributekeyrequest) | [UpdateResourceAttributeKeyResponse](#updateresourceattributekeyresponse) | |
| CheckResourceAttributeKeyArchiveImpact | [CheckResourceAttributeKeyArchiveImpactRequest](#checkresourceattributekeyarchiveimpactrequest) | [CheckResourceAttributeKeyArchiveImpactResponse](#checkresourceattributekeyarchiveimpactresponse) | |
| ArchiveResourceAttributeKey | [ArchiveResourceAttributeKeyRequest](#archiveresourceattributekeyrequest) | [ArchiveResourceAttributeKeyResponse](#archiveresourceattributekeyresponse) | Archives a resource\_attribute key AND all its associated enum values AND all its associated resource-attributes. |
| UnarchiveResourceAttributeKey | [UnarchiveResourceAttributeKeyRequest](#unarchiveresourceattributekeyrequest) | [UnarchiveResourceAttributeKeyResponse](#unarchiveresourceattributekeyresponse) | Unarchives a resource\_attribute key BUT NOT its associated enum values OR resource-attributes. |
| BatchArchiveResourceAttributeKeys | [BatchArchiveResourceAttributeKeysRequest](#batcharchiveresourceattributekeysrequest) | [BatchArchiveResourceAttributeKeysResponse](#batcharchiveresourceattributekeysresponse) | Archives multiple resource\_attribute keys AND all their associated enum values AND all their associated resource-attributes. |
| BatchUnarchiveResourceAttributeKeys | [BatchUnarchiveResourceAttributeKeysRequest](#batchunarchiveresourceattributekeysrequest) | [BatchUnarchiveResourceAttributeKeysResponse](#batchunarchiveresourceattributekeysresponse) | Unarchives multiple resource\_attribute keys BUT NOT their associated enum values OR resource-attributes. |
| CreateResourceAttributeEnumValue | [CreateResourceAttributeEnumValueRequest](#createresourceattributeenumvaluerequest) | [CreateResourceAttributeEnumValueResponse](#createresourceattributeenumvalueresponse) | |
| GetResourceAttributeEnumValue | [GetResourceAttributeEnumValueRequest](#getresourceattributeenumvaluerequest) | [GetResourceAttributeEnumValueResponse](#getresourceattributeenumvalueresponse) | |
| ListResourceAttributeEnumValues | [ListResourceAttributeEnumValuesRequest](#listresourceattributeenumvaluesrequest) | [ListResourceAttributeEnumValuesResponse](#listresourceattributeenumvaluesresponse) | |
| UpdateResourceAttributeEnumValue | [UpdateResourceAttributeEnumValueRequest](#updateresourceattributeenumvaluerequest) | [UpdateResourceAttributeEnumValueResponse](#updateresourceattributeenumvalueresponse) | |
| ArchiveResourceAttributeEnumValue | [ArchiveResourceAttributeEnumValueRequest](#archiveresourceattributeenumvaluerequest) | [ArchiveResourceAttributeEnumValueResponse](#archiveresourceattributeenumvalueresponse) | Archives an enum value and migrates all resource-attributes with that value to a replacement value. |
| UnarchiveResourceAttributeEnumValue | [UnarchiveResourceAttributeEnumValueRequest](#unarchiveresourceattributeenumvaluerequest) | [UnarchiveResourceAttributeEnumValueResponse](#unarchiveresourceattributeenumvalueresponse) | Unarchives an enum value BUT DOES NOT migrate resource-attributes with a replacement value back to the original value. |
| BatchArchiveResourceAttributeEnumValues | [BatchArchiveResourceAttributeEnumValuesRequest](#batcharchiveresourceattributeenumvaluesrequest) | [BatchArchiveResourceAttributeEnumValuesResponse](#batcharchiveresourceattributeenumvaluesresponse) | Archives multiple enum values and migrates all resource-attributes with those values to their respective replacement values. |
| BatchUnarchiveResourceAttributeEnumValues | [BatchUnarchiveResourceAttributeEnumValuesRequest](#batchunarchiveresourceattributeenumvaluesrequest) | [BatchUnarchiveResourceAttributeEnumValuesResponse](#batchunarchiveresourceattributeenumvaluesresponse) | Unarchives multiple enum values BUT DOES NOT migrate resource-attributes with a replacement value back to the original value. |
| BatchCreateResourceAttributes | [BatchCreateResourceAttributesRequest](#batchcreateresourceattributesrequest) | [BatchCreateResourceAttributesResponse](#batchcreateresourceattributesresponse) | Creates resource-attributes for multiple entities with the same key-value pair. |
| GetResourceAttribute | [GetResourceAttributeRequest](#getresourceattributerequest) | [GetResourceAttributeResponse](#getresourceattributeresponse) | |
| ListResourceAttributes | [ListResourceAttributesRequest](#listresourceattributesrequest) | [ListResourceAttributesResponse](#listresourceattributesresponse) | |
| ListResourceAttributesByEntity | [ListResourceAttributesByEntityRequest](#listresourceattributesbyentityrequest) | [ListResourceAttributesByEntityResponse](#listresourceattributesbyentityresponse) | Lists all resource-attributes for a specific entity. Excludes archived by default. |
| BatchListResourceAttributesByEntity | [BatchListResourceAttributesByEntityRequest](#batchlistresourceattributesbyentityrequest) | [BatchListResourceAttributesByEntityResponse](#batchlistresourceattributesbyentityresponse) | Batch lists all resource-attributes for multiple entities. Excludes archived by default. |
| ArchiveResourceAttribute | [ArchiveResourceAttributeRequest](#archiveresourceattributerequest) | [ArchiveResourceAttributeResponse](#archiveresourceattributeresponse) | |
| UnarchiveResourceAttribute | [UnarchiveResourceAttributeRequest](#unarchiveresourceattributerequest) | [UnarchiveResourceAttributeResponse](#unarchiveresourceattributeresponse) | |
| BatchArchiveResourceAttributes | [BatchArchiveResourceAttributesRequest](#batcharchiveresourceattributesrequest) | [BatchArchiveResourceAttributesResponse](#batcharchiveresourceattributesresponse) | Archives multiple resource-attributes. |
| BatchUnarchiveResourceAttributes | [BatchUnarchiveResourceAttributesRequest](#batchunarchiveresourceattributesrequest) | [BatchUnarchiveResourceAttributesResponse](#batchunarchiveresourceattributesresponse) | Unarchives multiple resource-attributes. |
## Messages
*Data models used across requests/responses.*
### ArchiveResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| archived\_enum\_value\_id | string | | |
| replacement\_enum\_value\_id | string | | When the archived\_enum\_value\_id is archived all resource-attributes that reference it will be migrated to the replacement\_enum\_value\_id if provided. Otherwise, resource-attributes that reference it will be archived as well. |
### ArchiveResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
| :----------------------------- | :---- | :---- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| resource\_attributes\_migrated | int32 | | Total number of resource-attributes migrated or archived by this operation. When a replacement enum value is provided, this represents attributes migrated to the new value. When no replacement is provided, this represents attributes that were archived. |
### ArchiveResourceAttributeKeyRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_key\_id | string | | |
### ArchiveResourceAttributeKeyResponse
*This message has no fields.*
### ArchiveResourceAttributeRequest
| Field | Type | Label | Description |
| :---------------------- | :----- | :---- | :---------- |
| resource\_attribute\_id | string | | |
### ArchiveResourceAttributeResponse
*This message has no fields.*
### BatchArchiveResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
| :----------------- | :------------------------------------------------------------------------------------------------------------------------------------ | :------- | :---------- |
| archival\_requests | [BatchArchiveResourceAttributeEnumValuesRequest.EnumValueArchival](#batcharchiveresourceattributeenumvaluesrequest-enumvaluearchival) | repeated | |
### BatchArchiveResourceAttributeEnumValuesRequest.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 resource-attributes that reference it will be migrated to the replacement\_enum\_value\_id if provided. Otherwise, resource-attributes that reference it will be archived as well. |
### BatchArchiveResourceAttributeEnumValuesResponse
| Field | Type | Label | Description |
| :------------------------------------ | :---- | :---- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| total\_resource\_attributes\_migrated | int32 | | Total number of resource-attributes migrated or archived across all enum value operations. This includes both attributes migrated to replacement values and attributes archived without replacement. |
### BatchArchiveResourceAttributeKeysRequest
| Field | Type | Label | Description |
| :---------------------------- | :----- | :------- | :---------- |
| resource\_attribute\_key\_ids | string | repeated | |
### BatchArchiveResourceAttributeKeysResponse
*This message has no fields.*
### BatchArchiveResourceAttributesRequest
| Field | Type | Label | Description |
| :----------------------- | :----- | :------- | :---------- |
| resource\_attribute\_ids | string | repeated | |
### BatchArchiveResourceAttributesResponse
*This message has no fields.*
### BatchCreateResourceAttributesRequest
ResourceAttribute RPC messages
| Field | Type | Label | Description |
| :------------------------------------------------- | :---------------------------------------------------------------------- | :------- | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| resource\_attribute\_key\_id | string | | |
| oneof value. resource\_attribute\_enum\_value\_id | string | | For ENUM type: exactly one enum value ID. |
| oneof value. resource\_attribute\_enum\_value\_ids | [ResourceAttributeEnumValueIdList](#resourceattributeenumvalueidlist) | | 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 entity+key will be archived. |
| oneof value. boolean\_value | bool | | |
| oneof value. number\_value | int64 | | |
| entities | [ResourceAttributeEntityIdentifier](#resourceattributeentityidentifier) | repeated | |
### BatchCreateResourceAttributesResponse
| Field | Type | Label | Description |
| :------------------- | :-------------------------------------- | :------- | :---------- |
| resource\_attributes | [ResourceAttribute](#resourceattribute) | repeated | |
### BatchListResourceAttributesByEntityRequest
| Field | Type | Label | Description |
| :---------------- | :---------------------------------------------------------------------- | :------- | :------------------------------------------------------------------ |
| entities | [ResourceAttributeEntityIdentifier](#resourceattributeentityidentifier) | repeated | |
| include\_archived | bool | | Whether to include archived resource-attributes. Defaults to false. |
### BatchListResourceAttributesByEntityResponse
| Field | Type | Label | Description |
| :------ | :-------------------------------------------------------------------------------------------------------------------------------------------- | :------- | :---------- |
| results | [BatchListResourceAttributesByEntityResponse.EntityResourceAttributes](#batchlistresourceattributesbyentityresponse-entityresourceattributes) | repeated | |
### BatchListResourceAttributesByEntityResponse.EntityResourceAttributes
| Field | Type | Label | Description |
| :------------------- | :---------------------------------------------------------------------- | :------- | :-------------------------------------- |
| entity | [ResourceAttributeEntityIdentifier](#resourceattributeentityidentifier) | | The entity the attributes belong to |
| resource\_attributes | [ResourceAttribute](#resourceattribute) | repeated | All resource-attributes for this entity |
### BatchUnarchiveResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
| :------------------------------------ | :----- | :------- | :---------- |
| resource\_attribute\_enum\_value\_ids | string | repeated | |
### BatchUnarchiveResourceAttributeEnumValuesResponse
*This message has no fields.*
### BatchUnarchiveResourceAttributeKeysRequest
| Field | Type | Label | Description |
| :---------------------------- | :----- | :------- | :---------- |
| resource\_attribute\_key\_ids | string | repeated | |
### BatchUnarchiveResourceAttributeKeysResponse
*This message has no fields.*
### BatchUnarchiveResourceAttributesRequest
| Field | Type | Label | Description |
| :----------------------- | :----- | :------- | :---------- |
| resource\_attribute\_ids | string | repeated | |
### BatchUnarchiveResourceAttributesResponse
*This message has no fields.*
### CheckResourceAttributeKeyArchiveImpactRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_key\_id | string | | |
### CheckResourceAttributeKeyArchiveImpactResponse
| Field | Type | Label | Description |
| :--------------------------------------------- | :---- | :---- | :----------------------------------------------------------------------------------------------- |
| active\_resource\_attribute\_assignment\_count | int64 | | The number of active resource attribute assignments that will be affected by archiving this key. |
### CreateResourceAttributeEnumValueRequest
ResourceAttribute Enum Value RPC messages
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_key\_id | string | | |
| display\_name | string | | |
| description | string | | |
### CreateResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
| :------------------------------- | :-------------------------------------------------------- | :---- | :---------- |
| resource\_attribute\_enum\_value | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | | |
### CreateResourceAttributeKeyRequest
ResourceAttribute Key RPC messages
| Field | Type | Label | Description |
| :-------------------- | :-------------------------------------------------------------------------------------------------------- | :------- | :-------------------------------------------------------------------------------------------- |
| display\_name | string | | |
| description | string | | |
| type | [ResourceAttributeKeyType](#resourceattributekeytype) | | |
| initial\_enum\_values | [CreateResourceAttributeKeyRequest.InitialEnumValue](#createresourceattributekeyrequest-initialenumvalue) | repeated | Optional initial enum values to create alongside the key. Only applicable for ENUM type keys. |
### CreateResourceAttributeKeyRequest.InitialEnumValue
Nested message for initial enum values in create requests.
| Field | Type | Label | Description |
| :------------ | :----- | :---- | :---------- |
| display\_name | string | | |
| description | string | | |
### CreateResourceAttributeKeyResponse
| Field | Type | Label | Description |
| :----------------------- | :-------------------------------------------------------- | :------- | :------------------------------------------------------------------------------ |
| resource\_attribute\_key | [ResourceAttributeKey](#resourceattributekey) | | |
| enum\_values | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | repeated | The enum values created alongside the key, if any were provided in the request. |
### GetResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
| :----------------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_enum\_value\_id | string | | |
### GetResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
| :------------------------------- | :-------------------------------------------------------- | :---- | :---------- |
| resource\_attribute\_enum\_value | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | | |
### GetResourceAttributeKeyRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_key\_id | string | | |
### GetResourceAttributeKeyResponse
| Field | Type | Label | Description |
| :----------------------- | :-------------------------------------------- | :---- | :---------- |
| resource\_attribute\_key | [ResourceAttributeKey](#resourceattributekey) | | |
### GetResourceAttributeRequest
| Field | Type | Label | Description |
| :---------------------- | :----- | :---- | :---------- |
| resource\_attribute\_id | string | | |
### GetResourceAttributeResponse
| Field | Type | Label | Description |
| :------------------ | :-------------------------------------- | :---- | :---------- |
| resource\_attribute | [ResourceAttribute](#resourceattribute) | | |
### ListResourceAttributeEnumValuesRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| resource\_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 `ListResourceAttributeEnumValues` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceAttributeEnumValues` must match the call that provided the page token. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `resource_attribute_enum_value_id`, `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](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). |
| 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 `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](https://google.aip.dev/132#ordering) Example: "name,created\_date desc" |
| include\_archived | bool | | Whether to include archived enum values. Defaults to false. |
### ListResourceAttributeEnumValuesResponse
| Field | Type | Label | Description |
| :-------------------------------- | :-------------------------------------------------------- | :------- | :---------- |
| resource\_attribute\_enum\_values | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | repeated | |
| next\_page\_token | string | | |
### ListResourceAttributeKeysRequest
| Field | Type | Label | Description |
| :---------------- | :----- | :---- | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| page\_size | uint32 | | The maximum number of resource\_attribute keys to return. The service may return fewer than this value. If unspecified, at most 50 resource\_attribute keys 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 `ListResourceAttributeKeys` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceAttributeKeys` must match the call that provided the page token. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `resource_attribute_key_id`, `name`, `description`, `key_type`, and `created_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](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). |
| order\_by | string | | How to order the retrieved resource\_attribute keys. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `created_date`, `modified_date`, and `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](https://google.aip.dev/132#ordering) Example: "created\_date desc,name" |
| include\_archived | bool | | Whether to include archived resource\_attribute keys. Defaults to false. |
### ListResourceAttributeKeysResponse
| Field | Type | Label | Description |
| :------------------------ | :-------------------------------------------- | :------- | :---------- |
| resource\_attribute\_keys | [ResourceAttributeKey](#resourceattributekey) | repeated | |
| next\_page\_token | string | | |
### ListResourceAttributesByEntityRequest
| Field | Type | Label | Description |
| :---------------- | :---------------------------------------------------------------------- | :---- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| entity | [ResourceAttributeEntityIdentifier](#resourceattributeentityidentifier) | | |
| include\_archived | bool | | Whether to include archived resource-attributes. Defaults to false. |
| page\_size | uint32 | | The maximum number of resource-attributes to return. The service may return fewer than this value. If unspecified, at most 50 resource-attributes 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 `ListResourceAttributesByEntity` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceAttributesByEntity` must match the call that provided the page token. |
### ListResourceAttributesByEntityResponse
| Field | Type | Label | Description |
| :------------------- | :-------------------------------------- | :------- | :---------- |
| resource\_attributes | [ResourceAttribute](#resourceattribute) | repeated | |
| next\_page\_token | string | | |
### ListResourceAttributesRequest
| Field | Type | Label | Description |
| :---------------- | :----- | :---- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| page\_size | uint32 | | The maximum number of resource-attributes to return. The service may return fewer than this value. If unspecified, at most 50 resource-attributes 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 `ListResourceAttributes` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListResourceAttributes` must match the call that provided the page token. |
| filter | string | | A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string. Available fields to filter by are `resource_attribute_id`, `entity_id`, `entity_type`, `resource_attribute_key_id`, `resource_attribute_enum_value_id`, `boolean_value`, `number_value`, `created_by_user_id`, and `created_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](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions). |
| order\_by | string | | How to order the retrieved resource-attributes. Formatted as a comma-separated string i.e. "FIELD\_NAME\[ desc],...". Available fields to order\_by are `created_date` and `entity.entity_id`. 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](https://google.aip.dev/132#ordering) Example: "entity.entity\_id,created\_date desc" |
| include\_archived | bool | | Whether to include archived resource-attributes. Defaults to false. |
### ListResourceAttributesResponse
| Field | Type | Label | Description |
| :------------------- | :-------------------------------------- | :------- | :---------- |
| resource\_attributes | [ResourceAttribute](#resourceattribute) | repeated | |
| next\_page\_token | string | | |
### ResourceAttribute
Represents the assignment of a resource\_attribute key-value pair to an entity (asset or channel).
| Field | Type | Label | Description |
| :------------------------------------------------ | :---------------------------------------------------------------------- | :---- | :------------------------------------------------------------------------------------------------------ |
| resource\_attribute\_id | string | | |
| organization\_id | string | | |
| entity | [ResourceAttributeEntityIdentifier](#resourceattributeentityidentifier) | | |
| resource\_attribute\_key\_id | string | | |
| key | [ResourceAttributeKey](#resourceattributekey) | | Populated in responses with full key details. |
| oneof value. resource\_attribute\_enum\_value\_id | string | | |
| oneof value. boolean\_value | bool | | |
| oneof value. number\_value | int64 | | |
| enum\_value\_details | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | | Populated in responses with full enum value details. |
| created\_date | google.protobuf.Timestamp | | The timestamp when the relation between the Entity and ResourceAttribute Key and Value was created. |
| created\_by\_user\_id | string | | |
| archived\_date | google.protobuf.Timestamp | | |
| is\_archived | bool | | Whether or not the resource attribute is archived. This is inferred from whether archived\_date is set. |
### ResourceAttributeEntityIdentifier
Represents an entity to which a resource\_attribute will be assigned.
| Field | Type | Label | Description |
| :----------- | :---------------------------------------------------------- | :---- | :---------- |
| entity\_id | string | | |
| entity\_type | [ResourceAttributeEntityType](#resourceattributeentitytype) | | |
### ResourceAttributeEnumValue
Represents a possible enumerable value for ENUM type resource\_attribute keys.
Users can add new enum values as needed.
| Field | Type | Label | Description |
| :----------------------------------- | :------------------------ | :---- | :---------------------------------------------------------------------------------------------- |
| resource\_attribute\_enum\_value\_id | string | | |
| resource\_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 enum value is archived. This is inferred from whether archived\_date is set. |
### ResourceAttributeEnumValueIdList
| Field | Type | Label | Description |
| :---- | :----- | :------- | :---------- |
| ids | string | repeated | |
### ResourceAttributeKey
A ResourceAttribute Key defines an attribute that can be assigned to Entities for the purpose of attribute based access control (ABAC).
| Field | Type | Label | Description |
| :--------------------------- | :---------------------------------------------------- | :---- | :--------------------------------------------------------------------------------------- |
| resource\_attribute\_key\_id | string | | |
| organization\_id | string | | |
| display\_name | string | | |
| description | string | | |
| type | [ResourceAttributeKeyType](#resourceattributekeytype) | | |
| 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 key is archived. This is inferred from whether archived\_date is set. |
### UnarchiveResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
| :----------------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_enum\_value\_id | string | | |
### UnarchiveResourceAttributeEnumValueResponse
*This message has no fields.*
### UnarchiveResourceAttributeKeyRequest
| Field | Type | Label | Description |
| :--------------------------- | :----- | :---- | :---------- |
| resource\_attribute\_key\_id | string | | |
### UnarchiveResourceAttributeKeyResponse
*This message has no fields.*
### UnarchiveResourceAttributeRequest
| Field | Type | Label | Description |
| :---------------------- | :----- | :---- | :---------- |
| resource\_attribute\_id | string | | |
### UnarchiveResourceAttributeResponse
*This message has no fields.*
### UpdateResourceAttributeEnumValueRequest
| Field | Type | Label | Description |
| :----------------------------------- | :------------------------------------------------------ | :---- | :---------------------------------------------------------------------------------------------------------- |
| resource\_attribute\_enum\_value\_id | string | | |
| display\_name | string | | |
| description | string | | |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. The fields available to be updated are `description` and `archived_date`. |
### UpdateResourceAttributeEnumValueResponse
| Field | Type | Label | Description |
| :------------------------------- | :-------------------------------------------------------- | :---- | :---------- |
| resource\_attribute\_enum\_value | [ResourceAttributeEnumValue](#resourceattributeenumvalue) | | |
### UpdateResourceAttributeKeyRequest
| Field | Type | Label | Description |
| :--------------------------- | :------------------------------------------------------ | :---- | :---------------------------------------------------------------------------------------------------------- |
| resource\_attribute\_key\_id | string | | |
| display\_name | string | | |
| description | string | | |
| update\_mask | [google.protobuf.FieldMask](#google-protobuf-fieldmask) | | The list of fields to be updated. The fields available to be updated are `description` and `archived_date`. |
### UpdateResourceAttributeKeyResponse
| Field | Type | Label | Description |
| :----------------------- | :-------------------------------------------- | :---- | :---------- |
| resource\_attribute\_key | [ResourceAttributeKey](#resourceattributekey) | | |
## Enums
*Allowed constant values used in message fields.*
### ResourceAttributeEntityType
| Name | Number | Description |
| :--------------------------------------------- | :----- | :---------- |
| RESOURCE\_ATTRIBUTE\_ENTITY\_TYPE\_UNSPECIFIED | 0 | |
| RESOURCE\_ATTRIBUTE\_ENTITY\_TYPE\_ASSET | 1 | |
| RESOURCE\_ATTRIBUTE\_ENTITY\_TYPE\_CHANNEL | 2 | |
| RESOURCE\_ATTRIBUTE\_ENTITY\_TYPE\_RUN | 3 | |
### ResourceAttributeKeyType
Values become selectable enumerable options.
| Name | Number | Description |
| :-------------------------------------------- | :----- | :---------- |
| RESOURCE\_ATTRIBUTE\_KEY\_TYPE\_UNSPECIFIED | 0 | |
| RESOURCE\_ATTRIBUTE\_KEY\_TYPE\_ENUM | 1 | |
| RESOURCE\_ATTRIBUTE\_KEY\_TYPE\_BOOLEAN | 2 | |
| RESOURCE\_ATTRIBUTE\_KEY\_TYPE\_NUMBER | 3 | |
| RESOURCE\_ATTRIBUTE\_KEY\_TYPE\_SET\_OF\_ENUM | 4 | |