Variable OpenApiPoliciesMethodsConst

OpenApiPoliciesMethods: {
    createPolicy: (
        createPolicyBody: CreatePolicyBody,
        options?: string,
    ) => Promise<Policy>;
    deletePolicy: (policyId: string, options?: string) => Promise<void>;
    getPolicyById: (policyId: string, options?: string) => Promise<Policy>;
    listPolicies: (
        params?: ListPoliciesParams,
        options?: string,
    ) => Promise<ListPolicies200>;
    updatePolicy: (
        policyId: string,
        updatePolicyBody: UpdatePolicyBody,
        options?: string,
    ) => Promise<Policy>;
} = ...

Type declaration

  • createPolicy: (createPolicyBody: CreatePolicyBody, options?: string) => Promise<Policy>

    Create a policy that can be used to govern the behavior of accounts.

  • deletePolicy: (policyId: string, options?: string) => Promise<void>

    Delete a policy by its ID. This will have the effect of removing the policy from all accounts that are currently using it.

  • getPolicyById: (policyId: string, options?: string) => Promise<Policy>

    Get a policy by its ID.

  • listPolicies: (params?: ListPoliciesParams, options?: string) => Promise<ListPolicies200>

    Lists the policies belonging to the developer's CDP Project. Use the scope parameter to filter the policies by scope. The response is paginated, and by default, returns 20 policies per page.

  • updatePolicy: (
        policyId: string,
        updatePolicyBody: UpdatePolicyBody,
        options?: string,
    ) => Promise<Policy>

    Updates a policy by its ID. This will have the effect of applying the updated policy to all accounts that are currently using it.

Settings

Member Visibility