@flowcore/cli-plugin-iam 1.0.0

package/dist/utils/clients/iam/Api.d.ts

@@ -0,0 +1,707 @@
+import { HttpClient, type RequestParams } from "./http-client.js";
+export declare class Api<SecurityDataType = unknown> extends HttpClient<SecurityDataType> {
+    /**
+     * @description Get all policies for the current user
+     *
+     * @tags policies
+     * @name GetApiV1Policies
+     * @request GET:/api/v1/policies/
+     * @secure
+     */
+    getApiV1Policies: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    } & {
+        /** The id of the policy */
+        id: string;
+    })[], any>>;
+    /**
+     * @description Create a new policy
+     *
+     * @tags policies
+     * @name PostApiV1Policies
+     * @request POST:/api/v1/policies/
+     * @secure
+     */
+    postApiV1Policies: (data: {
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
+    /**
+     * @description Get a policy by id
+     *
+     * @tags policies
+     * @name GetApiV1PoliciesById
+     * @request GET:/api/v1/policies/{id}
+     * @secure
+     */
+    getApiV1PoliciesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
+    /**
+     * @description Update a policy by id
+     *
+     * @tags policies
+     * @name PatchApiV1PoliciesById
+     * @request PATCH:/api/v1/policies/{id}
+     * @secure
+     */
+    patchApiV1PoliciesById: (id: string, data: {
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
+    /**
+     * @description Archive a policy by id
+     *
+     * @tags policies
+     * @name DeleteApiV1PoliciesById
+     * @request DELETE:/api/v1/policies/{id}
+     * @secure
+     */
+    deleteApiV1PoliciesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The message of the archive policy */
+        message: string;
+    }, any>>;
+    /**
+     * @description Get all roles for the current user
+     *
+     * @tags roles
+     * @name GetApiV1Roles
+     * @request GET:/api/v1/roles/
+     * @secure
+     */
+    getApiV1Roles: (params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** The id of the role */
+        id: string;
+    })[], any>>;
+    /**
+     * @description Create a new role
+     *
+     * @tags roles
+     * @name PostApiV1Roles
+     * @request POST:/api/v1/roles/
+     * @secure
+     */
+    postApiV1Roles: (data: {
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<object, any>>;
+    /**
+     * @description Get a role by ID
+     *
+     * @tags roles
+     * @name GetApiV1RolesById
+     * @request GET:/api/v1/roles/{id}
+     * @secure
+     */
+    getApiV1RolesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** Role ID */
+        id: string;
+        /** The archived status of the role */
+        archived: boolean;
+    } & {
+        /** Role ID */
+        id: string;
+        /** The archived status of the role */
+        archived: boolean;
+    }, any>>;
+    /**
+     * @description Update a role by ID
+     *
+     * @tags roles
+     * @name PatchApiV1RolesById
+     * @request PATCH:/api/v1/roles/{id}
+     * @secure
+     */
+    patchApiV1RolesById: (id: string, data: {
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** Role ID */
+        id: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** Role ID */
+        id: string;
+    } & {
+        /** The archived status of the role */
+        archived: boolean;
+    }, any>>;
+    /**
+     * @description Archive a role by ID
+     *
+     * @tags roles
+     * @name DeleteApiV1RolesById
+     * @request DELETE:/api/v1/roles/{id}
+     * @secure
+     */
+    deleteApiV1RolesById: (id: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The message of the archive role */
+        message: string;
+    }, any>>;
+    /**
+     * @description Fetch policies for an organization
+     *
+     * @tags policy-associations
+     * @name GetApiV1PolicyAssociationsOrganizationByOrganizationId
+     * @request GET:/api/v1/policy-associations/organization/{organizationId}
+     * @secure
+     */
+    getApiV1PolicyAssociationsOrganizationByOrganizationId: (organizationId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    } & {
+        /** The id of the policy */
+        id: string;
+    })[], any>>;
+    /**
+     * @description Fetch policies for a user
+     *
+     * @tags policy-associations
+     * @name GetApiV1PolicyAssociationsUserByUserId
+     * @request GET:/api/v1/policy-associations/user/{userId}/
+     * @secure
+     */
+    getApiV1PolicyAssociationsUserByUserId: (userId: string, query?: {
+        /** The ID of the organization */
+        organizationId?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    } & {
+        /** The id of the policy */
+        id: string;
+        /** The archived status of the policy */
+        archived: boolean;
+    })[], any>>;
+    /**
+     * @description Link a policy to a user
+     *
+     * @tags policy-associations
+     * @name PostApiV1PolicyAssociationsUserByUserId
+     * @request POST:/api/v1/policy-associations/user/{userId}/
+     * @secure
+     */
+    postApiV1PolicyAssociationsUserByUserId: (userId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the user */
+        userId: string;
+    }, any>>;
+    /**
+     * @description Unlink a policy from a user
+     *
+     * @tags policy-associations
+     * @name DeleteApiV1PolicyAssociationsUserByUserId
+     * @request DELETE:/api/v1/policy-associations/user/{userId}/
+     * @secure
+     */
+    deleteApiV1PolicyAssociationsUserByUserId: (userId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the user */
+        userId: string;
+    }, any>>;
+    /**
+     * @description Fetch policies for a key
+     *
+     * @tags policy-associations
+     * @name GetApiV1PolicyAssociationsKeyByKeyId
+     * @request GET:/api/v1/policy-associations/key/{keyId}/
+     * @secure
+     */
+    getApiV1PolicyAssociationsKeyByKeyId: (keyId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    } & {
+        /** The id of the policy */
+        id: string;
+        /** The archived status of the policy */
+        archived: boolean;
+    })[], any>>;
+    /**
+     * @description Link a policy to a key
+     *
+     * @tags policy-associations
+     * @name PostApiV1PolicyAssociationsKeyByKeyId
+     * @request POST:/api/v1/policy-associations/key/{keyId}/
+     * @secure
+     */
+    postApiV1PolicyAssociationsKeyByKeyId: (keyId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the key */
+        keyId: string;
+    }, any>>;
+    /**
+     * @description Unlink a policy from a key
+     *
+     * @tags policy-associations
+     * @name DeleteApiV1PolicyAssociationsKeyByKeyId
+     * @request DELETE:/api/v1/policy-associations/key/{keyId}/
+     * @secure
+     */
+    deleteApiV1PolicyAssociationsKeyByKeyId: (keyId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the key */
+        keyId: string;
+    }, any>>;
+    /**
+     * @description Fetch policies for a role
+     *
+     * @tags policy-associations
+     * @name GetApiV1PolicyAssociationsRoleByRoleId
+     * @request GET:/api/v1/policy-associations/role/{roleId}/
+     * @secure
+     */
+    getApiV1PolicyAssociationsRoleByRoleId: (roleId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** The id of the organization */
+        organizationId: string;
+        /** The name of the policy */
+        name: string;
+        /** The version of the policy */
+        version: string;
+        policyDocuments: {
+            /** The id of the statement */
+            statementId?: string;
+            /** The resource of the statement */
+            resource: string;
+            /** The action of the statement */
+            action: string | string[];
+        }[];
+        /** The description of the policy */
+        description?: string;
+        /** The principal role that can access the resource */
+        principal?: string;
+    } & {
+        /** The id of the policy */
+        id: string;
+        /** The archived status of the policy */
+        archived: boolean;
+    })[], any>>;
+    /**
+     * @description Link a policy to a role
+     *
+     * @tags policy-associations
+     * @name PostApiV1PolicyAssociationsRoleByRoleId
+     * @request POST:/api/v1/policy-associations/role/{roleId}/
+     * @secure
+     */
+    postApiV1PolicyAssociationsRoleByRoleId: (roleId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the role */
+        roleId: string;
+    }, any>>;
+    /**
+     * @description Unlink a policy from a role
+     *
+     * @tags policy-associations
+     * @name DeleteApiV1PolicyAssociationsRoleByRoleId
+     * @request DELETE:/api/v1/policy-associations/role/{roleId}/
+     * @secure
+     */
+    deleteApiV1PolicyAssociationsRoleByRoleId: (roleId: string, data: {
+        /** The ID of the policy */
+        policyId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the policy */
+        policyId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the role */
+        roleId: string;
+    }, any>>;
+    /**
+     * @description Fetch roles for an organization
+     *
+     * @tags role-associations
+     * @name GetApiV1RoleAssociationsOrganizationByOrganizationId
+     * @request GET:/api/v1/role-associations/organization/{organizationId}
+     * @secure
+     */
+    getApiV1RoleAssociationsOrganizationByOrganizationId: (organizationId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** The id of the role */
+        id: string;
+    })[], any>>;
+    /**
+     * @description Fetch roles for a user
+     *
+     * @tags role-associations
+     * @name GetApiV1RoleAssociationsUserByUserId
+     * @request GET:/api/v1/role-associations/user/{userId}/
+     * @secure
+     */
+    getApiV1RoleAssociationsUserByUserId: (userId: string, query?: {
+        /** The ID of the organization */
+        organizationId?: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** Role ID */
+        id: string;
+        /** The archived status of the role */
+        archived: boolean;
+    })[], any>>;
+    /**
+     * @description Link a role to a user
+     *
+     * @tags role-associations
+     * @name PostApiV1RoleAssociationsUserByUserId
+     * @request POST:/api/v1/role-associations/user/{userId}/
+     * @secure
+     */
+    postApiV1RoleAssociationsUserByUserId: (userId: string, data: {
+        /** The ID of the role */
+        roleId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the role */
+        roleId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the user */
+        userId: string;
+    }, any>>;
+    /**
+     * @description Unlink a role from a user
+     *
+     * @tags role-associations
+     * @name DeleteApiV1RoleAssociationsUserByUserId
+     * @request DELETE:/api/v1/role-associations/user/{userId}/
+     * @secure
+     */
+    deleteApiV1RoleAssociationsUserByUserId: (userId: string, data: {
+        /** The ID of the role */
+        roleId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the role */
+        roleId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the user */
+        userId: string;
+    }, any>>;
+    /**
+     * @description Fetch roles for a key
+     *
+     * @tags role-associations
+     * @name GetApiV1RoleAssociationsKeyByKeyId
+     * @request GET:/api/v1/role-associations/key/{keyId}/
+     * @secure
+     */
+    getApiV1RoleAssociationsKeyByKeyId: (keyId: string, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<({
+        /** Organization ID */
+        organizationId: string;
+        /** Role name */
+        name: string;
+        /** Role description */
+        description?: string;
+    } & {
+        /** Role ID */
+        id: string;
+        /** The archived status of the role */
+        archived: boolean;
+    })[], any>>;
+    /**
+     * @description Link a role to a key
+     *
+     * @tags role-associations
+     * @name PostApiV1RoleAssociationsKeyByKeyId
+     * @request POST:/api/v1/role-associations/key/{keyId}/
+     * @secure
+     */
+    postApiV1RoleAssociationsKeyByKeyId: (keyId: string, data: {
+        /** The ID of the role */
+        roleId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the role */
+        roleId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the key */
+        keyId: string;
+    }, any>>;
+    /**
+     * @description Unlink a role from a key
+     *
+     * @tags role-associations
+     * @name DeleteApiV1RoleAssociationsKeyByKeyId
+     * @request DELETE:/api/v1/role-associations/key/{keyId}/
+     * @secure
+     */
+    deleteApiV1RoleAssociationsKeyByKeyId: (keyId: string, data: {
+        /** The ID of the role */
+        roleId: string;
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /** The ID of the role */
+        roleId: string;
+        /** The ID of the organization */
+        organizationId: string;
+        /** The ID of the key */
+        keyId: string;
+    }, any>>;
+    /**
+     * @description Validate if a user can perform actions
+     *
+     * @tags validate
+     * @name PostApiV1ValidateUsersById
+     * @request POST:/api/v1/validate/users/{id}
+     * @secure
+     */
+    postApiV1ValidateUsersById: (id: string, data: {
+        /** The mode of validation of the flowcore resource notation, either by tenant or organization id */
+        mode: "tenant" | "organization";
+        requestedAccess: {
+            /** The action or actions to validate against */
+            action: string | string[];
+            /** The resource to validate, in order of granularity. First match wins. */
+            resource: string[];
+        }[];
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * The action is valid
+         * @default true
+         */
+        valid: true;
+        /** The hash of the policy/key/user/role association that was validated */
+        checksum: string;
+        validPolicies: {
+            /** The frn of the policy */
+            policyFrn: string;
+            /** The statement id of the policy */
+            statementId: string;
+        }[];
+    }, {
+        /** The error message */
+        message: string;
+        /**
+         * The action is invalid
+         * @default false
+         */
+        valid: false;
+        validPolicies: {
+            /** The frn of the policy */
+            policyFrn: string;
+            /** The statement id of the policy */
+            statementId: string;
+        }[];
+        invalidRequest: {
+            /** The resource to validate, in order of granularity. First match wins. */
+            resource: string[];
+            /** The action or actions to validate against */
+            action: string | string[];
+        }[];
+    }>>;
+    /**
+     * @description Validate if a key can perform actions
+     *
+     * @tags validate
+     * @name PostApiV1ValidateKeysById
+     * @request POST:/api/v1/validate/keys/{id}
+     * @secure
+     */
+    postApiV1ValidateKeysById: (id: string, data: {
+        /** The mode of validation of the flowcore resource notation, either by tenant or organization id */
+        mode: "tenant" | "organization";
+        requestedAccess: {
+            /** The action or actions to validate against */
+            action: string | string[];
+            /** The resource to validate, in order of granularity. First match wins. */
+            resource: string[];
+        }[];
+    }, params?: RequestParams) => Promise<import("./http-client.js").HttpResponse<{
+        /**
+         * The action is valid
+         * @default true
+         */
+        valid: true;
+        /** The hash of the policy/key/user/role association that was validated */
+        checksum: string;
+        validPolicies: {
+            /** The frn of the policy */
+            policyFrn: string;
+            /** The statement id of the policy */
+            statementId: string;
+        }[];
+    }, {
+        /** The error message */
+        message: string;
+        /**
+         * The action is invalid
+         * @default false
+         */
+        valid: false;
+        validPolicies: {
+            /** The frn of the policy */
+            policyFrn: string;
+            /** The statement id of the policy */
+            statementId: string;
+        }[];
+        invalidRequest: {
+            /** The resource to validate, in order of granularity. First match wins. */
+            resource: string[];
+            /** The action or actions to validate against */
+            action: string | string[];
+        }[];
+    }>>;
+}