Skip to main content

Interfaces

CreatePolicyOptions

Defined in: client/policies/policies.types.ts:53 Options for creating a Policy.

Properties

idempotencyKey?
Defined in: client/policies/policies.types.ts:58 The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.
policy
Defined in: client/policies/policies.types.ts:63 The policy definition to create. Contains the scope, description, and rules for the policy.
description?
An optional human-readable description for the policy. Limited to 50 characters of alphanumeric characters, spaces, commas, and periods.
rules
Array of rules that comprise the policy. Limited to a maximum of 10 rules per policy.
scope
The scope of the policy. “project” applies to the entire project, “account” applies to specific accounts.

DeletePolicyOptions

Defined in: client/policies/policies.types.ts:80 Options for deleting a Policy.

Properties

id
Defined in: client/policies/policies.types.ts:85 The unique identifier of the policy to delete. This is a UUID that’s generated when the policy is created.
idempotencyKey?
Defined in: client/policies/policies.types.ts:90 The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.

GetPolicyByIdOptions

Defined in: client/policies/policies.types.ts:69 Options for retrieving a Policy by ID.

Properties

id
Defined in: client/policies/policies.types.ts:74 The unique identifier of the policy to retrieve. This is a UUID that’s generated when the policy is created.

ListPoliciesOptions

Defined in: client/policies/policies.types.ts:26

Properties

pageSize?
Defined in: client/policies/policies.types.ts:28 The page size to paginate through the accounts.
pageToken?
Defined in: client/policies/policies.types.ts:30 The page token to paginate through the accounts.
scope?
Defined in: client/policies/policies.types.ts:34 The scope of the policies to return. If project, the response will include exactly one policy, which is the project-level policy. If account, the response will include all account-level policies for the developer’s CDP Project.

ListPoliciesResult

Defined in: client/policies/policies.types.ts:40 The result of listing policies.

Properties

nextPageToken?
Defined in: client/policies/policies.types.ts:47 The next page token to paginate through the policies. If undefined, there are no more policies to paginate through.
policies
Defined in: client/policies/policies.types.ts:42 The list of policies matching the query parameters.

UpdatePolicyOptions

Defined in: client/policies/policies.types.ts:96 Options for updating a Policy.

Properties

id
Defined in: client/policies/policies.types.ts:101 The unique identifier of the policy to update. This is a UUID that’s generated when the policy is created.
idempotencyKey?
Defined in: client/policies/policies.types.ts:111 The idempotency key to ensure the request is processed exactly once. Used to safely retry requests without accidentally performing the same operation twice.
policy
Defined in: client/policies/policies.types.ts:106 The updated policy definition. Contains the description and rules for the policy.
description?
An optional human-readable description for the policy. Limited to 50 characters of alphanumeric characters, spaces, commas, and periods.
rules
Array of rules that comprise the policy. Limited to a maximum of 10 rules per policy.

Type Aliases