Method: organizations.locations.encryptionConfigs.list

List EncryptionConfigs.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=organizations/*/locations/*}/encryptionConfigs

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The location for which the EncryptionConfig is to be listed.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.encryptionConfig.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of EncryptionConfigs to return. The service may return fewer than this value. If unspecified, at most 10 EncryptionConfigs will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

pageToken

string

Optional. Page token received from a previous encryptionConfigs.list call. Provide this to retrieve the subsequent page. When paginating, the parameters - filter and orderBy provided to encryptionConfigs.list must match the call that provided the page token.

filter

string

Optional. Filter the EncryptionConfigs to be returned. Using bare literals: (These values will be matched anywhere it may appear in the object's field values) * filter=some_value Using fields: (These values will be matched only in the specified field) * filter=some_field=some_value Supported fields: * name, key, createTime, updateTime, encryptionState Example: * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config conjunctions: (AND, OR, NOT) * filter=name=organizations/123/locations/us-central1/encryptionConfigs/test-config AND mode=CMEK logical operators: (>, <, >=, <=, !=, =, :), * filter=createTime>2024-05-01T00:00:00.000Z

orderBy

string

Optional. Order by fields for the result.

Request body

The request body must be empty.

Response body

List EncryptionConfigs Response

If successful, the response body contains data with the following structure:

JSON representation
{
  "encryptionConfigs": [
    {
      object (EncryptionConfig)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
encryptionConfigs[]

object (EncryptionConfig)

The list of EncryptionConfigs under the given parent location.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

unreachableLocations[]

string

Locations that could not be reached.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.