@flowcore/cli-plugin-iam 1.3.1 → 1.5.0

package/dist/utils/clients/iam/Api.js

@@ -11,13 +11,43 @@
 import { ContentType, HttpClient } from "./http-client.js";
 export class Api extends HttpClient {
     /**
-     * @description Get all policies for the current user
-     *
-     * @tags policies
-     * @name GetApiV1Policies
-     * @request GET:/api/v1/policies/
-     * @secure
-     */
+ * @description Get all policies for the current user
+ *
+ * @tags policies
+ * @name GetApiV1Policies
+ * @request GET:/api/v1/policies/
+ * @secure
+ * @response `200` `(({
+  \** 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,
+  \** If the policy is managed by flowcore *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the policy *\
+    id: string,
+  \** The frn of the policy *\
+    frn: string,
+
+}))[]`
+ */
     getApiV1Policies = (params = {}) => this.request({
         path: `/api/v1/policies/`,
         method: "GET",
@@ -32,6 +62,7 @@ export class Api extends HttpClient {
      * @name PostApiV1Policies
      * @request POST:/api/v1/policies/
      * @secure
+     * @response `200` `object`
      */
     postApiV1Policies = (data, params = {}) => this.request({
         path: `/api/v1/policies/`,
@@ -49,6 +80,7 @@ export class Api extends HttpClient {
      * @name GetApiV1PoliciesById
      * @request GET:/api/v1/policies/{id}
      * @secure
+     * @response `200` `object`
      */
     getApiV1PoliciesById = (id, params = {}) => this.request({
         path: `/api/v1/policies/${id}`,
@@ -64,6 +96,7 @@ export class Api extends HttpClient {
      * @name PatchApiV1PoliciesById
      * @request PATCH:/api/v1/policies/{id}
      * @secure
+     * @response `200` `object`
      */
     patchApiV1PoliciesById = (id, data, params = {}) => this.request({
         path: `/api/v1/policies/${id}`,
@@ -75,13 +108,18 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Archive a policy by id
-     *
-     * @tags policies
-     * @name DeleteApiV1PoliciesById
-     * @request DELETE:/api/v1/policies/{id}
-     * @secure
-     */
+ * @description Archive a policy by id
+ *
+ * @tags policies
+ * @name DeleteApiV1PoliciesById
+ * @request DELETE:/api/v1/policies/{id}
+ * @secure
+ * @response `200` `{
+  \** The message of the archive policy *\
+    message: string,
+
+}`
+ */
     deleteApiV1PoliciesById = (id, params = {}) => this.request({
         path: `/api/v1/policies/${id}`,
         method: "DELETE",
@@ -90,13 +128,30 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Get all roles for the current user
-     *
-     * @tags roles
-     * @name GetApiV1Roles
-     * @request GET:/api/v1/roles/
-     * @secure
-     */
+ * @description Get all roles for the current user
+ *
+ * @tags roles
+ * @name GetApiV1Roles
+ * @request GET:/api/v1/roles/
+ * @secure
+ * @response `200` `(({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the role *\
+    id: string,
+  \** The frn of the role *\
+    frn?: string,
+
+}))[]`
+ */
     getApiV1Roles = (params = {}) => this.request({
         path: `/api/v1/roles/`,
         method: "GET",
@@ -111,6 +166,7 @@ export class Api extends HttpClient {
      * @name PostApiV1Roles
      * @request POST:/api/v1/roles/
      * @secure
+     * @response `200` `object`
      */
     postApiV1Roles = (data, params = {}) => this.request({
         path: `/api/v1/roles/`,
@@ -122,13 +178,40 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Get a role by ID
-     *
-     * @tags roles
-     * @name GetApiV1RolesById
-     * @request GET:/api/v1/roles/{id}
-     * @secure
-     */
+ * @description Get a role by ID
+ *
+ * @tags roles
+ * @name GetApiV1RolesById
+ * @request GET:/api/v1/roles/{id}
+ * @secure
+ * @response `200` `(({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** Role ID *\
+    id: string,
+  \** The archived status of the role *\
+    archived: boolean,
+  \** The frn of the role *\
+    frn?: string,
+
+}) & {
+  \** Role ID *\
+    id: string,
+  \** The archived status of the role *\
+    archived: boolean,
+  \** The frn of the role *\
+    frn: string,
+
+})`
+ */
     getApiV1RolesById = (id, params = {}) => this.request({
         path: `/api/v1/roles/${id}`,
         method: "GET",
@@ -137,13 +220,34 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Update a role by ID
-     *
-     * @tags roles
-     * @name PatchApiV1RolesById
-     * @request PATCH:/api/v1/roles/{id}
-     * @secure
-     */
+ * @description Update a role by ID
+ *
+ * @tags roles
+ * @name PatchApiV1RolesById
+ * @request PATCH:/api/v1/roles/{id}
+ * @secure
+ * @response `200` `(({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** Role ID *\
+    id: string,
+
+}) & {
+  \** The archived status of the role *\
+    archived: boolean,
+  \** The frn of the role *\
+    frn: string,
+
+})`
+ */
     patchApiV1RolesById = (id, data, params = {}) => this.request({
         path: `/api/v1/roles/${id}`,
         method: "PATCH",
@@ -154,13 +258,18 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Archive a role by ID
-     *
-     * @tags roles
-     * @name DeleteApiV1RolesById
-     * @request DELETE:/api/v1/roles/{id}
-     * @secure
-     */
+ * @description Archive a role by ID
+ *
+ * @tags roles
+ * @name DeleteApiV1RolesById
+ * @request DELETE:/api/v1/roles/{id}
+ * @secure
+ * @response `200` `{
+  \** The message of the archive role *\
+    message: string,
+
+}`
+ */
     deleteApiV1RolesById = (id, params = {}) => this.request({
         path: `/api/v1/roles/${id}`,
         method: "DELETE",
@@ -169,13 +278,43 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch associations for a policy
-     *
-     * @tags policy-associations
-     * @name GetApiV1PolicyAssociationsByPolicyId
-     * @request GET:/api/v1/policy-associations/{policyId}
-     * @secure
-     */
+ * @description Fetch associations for a policy
+ *
+ * @tags policy-associations
+ * @name GetApiV1PolicyAssociationsByPolicyId
+ * @request GET:/api/v1/policy-associations/{policyId}
+ * @secure
+ * @response `200` `{
+    keys: ({
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+})[],
+    users: ({
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+})[],
+    roles: ({
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the role *\
+    roleId: string,
+
+})[],
+
+}`
+ */
     getApiV1PolicyAssociationsByPolicyId = (policyId, params = {}) => this.request({
         path: `/api/v1/policy-associations/${policyId}`,
         method: "GET",
@@ -184,13 +323,43 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch policies for an organization
-     *
-     * @tags policy-associations
-     * @name GetApiV1PolicyAssociationsOrganizationByOrganizationId
-     * @request GET:/api/v1/policy-associations/organization/{organizationId}
-     * @secure
-     */
+ * @description Fetch policies for an organization
+ *
+ * @tags policy-associations
+ * @name GetApiV1PolicyAssociationsOrganizationByOrganizationId
+ * @request GET:/api/v1/policy-associations/organization/{organizationId}
+ * @secure
+ * @response `200` `(({
+  \** 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,
+  \** If the policy is managed by flowcore *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the policy *\
+    id: string,
+  \** The frn of the policy *\
+    frn: string,
+
+}))[]`
+ */
     getApiV1PolicyAssociationsOrganizationByOrganizationId = (organizationId, params = {}) => this.request({
         path: `/api/v1/policy-associations/organization/${organizationId}`,
         method: "GET",
@@ -199,13 +368,48 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch policies for a user
-     *
-     * @tags policy-associations
-     * @name GetApiV1PolicyAssociationsUserByUserId
-     * @request GET:/api/v1/policy-associations/user/{userId}/
-     * @secure
-     */
+ * @description Fetch policies for a user
+ *
+ * @tags policy-associations
+ * @name GetApiV1PolicyAssociationsUserByUserId
+ * @request GET:/api/v1/policy-associations/user/{userId}/
+ * @secure
+ * @response `200` `((({
+  \** 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,
+  \** If the policy is managed by flowcore *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the policy *\
+    id: string,
+  \** The archived status of the policy *\
+    archived: boolean,
+  \** The frn of the policy *\
+    frn: string,
+
+}) & {
+    frn: string,
+
+}))[]`
+ */
     getApiV1PolicyAssociationsUserByUserId = (userId, query, params = {}) => this.request({
         path: `/api/v1/policy-associations/user/${userId}/`,
         method: "GET",
@@ -215,13 +419,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Link a policy to a user
-     *
-     * @tags policy-associations
-     * @name PostApiV1PolicyAssociationsUserByUserId
-     * @request POST:/api/v1/policy-associations/user/{userId}/
-     * @secure
-     */
+ * @description Link a policy to a user
+ *
+ * @tags policy-associations
+ * @name PostApiV1PolicyAssociationsUserByUserId
+ * @request POST:/api/v1/policy-associations/user/{userId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+}`
+ */
     postApiV1PolicyAssociationsUserByUserId = (userId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/user/${userId}/`,
         method: "POST",
@@ -232,13 +445,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Unlink a policy from a user
-     *
-     * @tags policy-associations
-     * @name DeleteApiV1PolicyAssociationsUserByUserId
-     * @request DELETE:/api/v1/policy-associations/user/{userId}/
-     * @secure
-     */
+ * @description Unlink a policy from a user
+ *
+ * @tags policy-associations
+ * @name DeleteApiV1PolicyAssociationsUserByUserId
+ * @request DELETE:/api/v1/policy-associations/user/{userId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+}`
+ */
     deleteApiV1PolicyAssociationsUserByUserId = (userId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/user/${userId}/`,
         method: "DELETE",
@@ -249,13 +471,48 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch policies for a key
-     *
-     * @tags policy-associations
-     * @name GetApiV1PolicyAssociationsKeyByKeyId
-     * @request GET:/api/v1/policy-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Fetch policies for a key
+ *
+ * @tags policy-associations
+ * @name GetApiV1PolicyAssociationsKeyByKeyId
+ * @request GET:/api/v1/policy-associations/key/{keyId}/
+ * @secure
+ * @response `200` `((({
+  \** 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,
+  \** If the policy is managed by flowcore *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the policy *\
+    id: string,
+  \** The archived status of the policy *\
+    archived: boolean,
+  \** The frn of the policy *\
+    frn: string,
+
+}) & {
+    frn: string,
+
+}))[]`
+ */
     getApiV1PolicyAssociationsKeyByKeyId = (keyId, params = {}) => this.request({
         path: `/api/v1/policy-associations/key/${keyId}/`,
         method: "GET",
@@ -264,13 +521,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Link a policy to a key
-     *
-     * @tags policy-associations
-     * @name PostApiV1PolicyAssociationsKeyByKeyId
-     * @request POST:/api/v1/policy-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Link a policy to a key
+ *
+ * @tags policy-associations
+ * @name PostApiV1PolicyAssociationsKeyByKeyId
+ * @request POST:/api/v1/policy-associations/key/{keyId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+}`
+ */
     postApiV1PolicyAssociationsKeyByKeyId = (keyId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/key/${keyId}/`,
         method: "POST",
@@ -281,13 +547,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Unlink a policy from a key
-     *
-     * @tags policy-associations
-     * @name DeleteApiV1PolicyAssociationsKeyByKeyId
-     * @request DELETE:/api/v1/policy-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Unlink a policy from a key
+ *
+ * @tags policy-associations
+ * @name DeleteApiV1PolicyAssociationsKeyByKeyId
+ * @request DELETE:/api/v1/policy-associations/key/{keyId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+}`
+ */
     deleteApiV1PolicyAssociationsKeyByKeyId = (keyId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/key/${keyId}/`,
         method: "DELETE",
@@ -298,13 +573,48 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch policies for a role
-     *
-     * @tags policy-associations
-     * @name GetApiV1PolicyAssociationsRoleByRoleId
-     * @request GET:/api/v1/policy-associations/role/{roleId}/
-     * @secure
-     */
+ * @description Fetch policies for a role
+ *
+ * @tags policy-associations
+ * @name GetApiV1PolicyAssociationsRoleByRoleId
+ * @request GET:/api/v1/policy-associations/role/{roleId}/
+ * @secure
+ * @response `200` `((({
+  \** 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,
+  \** If the policy is managed by flowcore *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the policy *\
+    id: string,
+  \** The archived status of the policy *\
+    archived: boolean,
+  \** The frn of the policy *\
+    frn: string,
+
+}) & {
+    frn: string,
+
+}))[]`
+ */
     getApiV1PolicyAssociationsRoleByRoleId = (roleId, params = {}) => this.request({
         path: `/api/v1/policy-associations/role/${roleId}/`,
         method: "GET",
@@ -313,13 +623,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Link a policy to a role
-     *
-     * @tags policy-associations
-     * @name PostApiV1PolicyAssociationsRoleByRoleId
-     * @request POST:/api/v1/policy-associations/role/{roleId}/
-     * @secure
-     */
+ * @description Link a policy to a role
+ *
+ * @tags policy-associations
+ * @name PostApiV1PolicyAssociationsRoleByRoleId
+ * @request POST:/api/v1/policy-associations/role/{roleId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the role *\
+    roleId: string,
+
+}`
+ */
     postApiV1PolicyAssociationsRoleByRoleId = (roleId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/role/${roleId}/`,
         method: "POST",
@@ -330,13 +649,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Unlink a policy from a role
-     *
-     * @tags policy-associations
-     * @name DeleteApiV1PolicyAssociationsRoleByRoleId
-     * @request DELETE:/api/v1/policy-associations/role/{roleId}/
-     * @secure
-     */
+ * @description Unlink a policy from a role
+ *
+ * @tags policy-associations
+ * @name DeleteApiV1PolicyAssociationsRoleByRoleId
+ * @request DELETE:/api/v1/policy-associations/role/{roleId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the policy *\
+    policyId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the role *\
+    roleId: string,
+
+}`
+ */
     deleteApiV1PolicyAssociationsRoleByRoleId = (roleId, data, params = {}) => this.request({
         path: `/api/v1/policy-associations/role/${roleId}/`,
         method: "DELETE",
@@ -347,13 +675,34 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch associations for a role
-     *
-     * @tags role-associations
-     * @name GetApiV1RoleAssociationsByRoleId
-     * @request GET:/api/v1/role-associations/{roleId}
-     * @secure
-     */
+ * @description Fetch associations for a role
+ *
+ * @tags role-associations
+ * @name GetApiV1RoleAssociationsByRoleId
+ * @request GET:/api/v1/role-associations/{roleId}
+ * @secure
+ * @response `200` `{
+    keys: ({
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+})[],
+    users: ({
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+})[],
+
+}`
+ */
     getApiV1RoleAssociationsByRoleId = (roleId, params = {}) => this.request({
         path: `/api/v1/role-associations/${roleId}`,
         method: "GET",
@@ -362,13 +711,30 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch roles for an organization
-     *
-     * @tags role-associations
-     * @name GetApiV1RoleAssociationsOrganizationByOrganizationId
-     * @request GET:/api/v1/role-associations/organization/{organizationId}
-     * @secure
-     */
+ * @description Fetch roles for an organization
+ *
+ * @tags role-associations
+ * @name GetApiV1RoleAssociationsOrganizationByOrganizationId
+ * @request GET:/api/v1/role-associations/organization/{organizationId}
+ * @secure
+ * @response `200` `(({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** The id of the role *\
+    id: string,
+  \** The frn of the role *\
+    frn?: string,
+
+}))[]`
+ */
     getApiV1RoleAssociationsOrganizationByOrganizationId = (organizationId, params = {}) => this.request({
         path: `/api/v1/role-associations/organization/${organizationId}`,
         method: "GET",
@@ -377,13 +743,35 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch roles for a user
-     *
-     * @tags role-associations
-     * @name GetApiV1RoleAssociationsUserByUserId
-     * @request GET:/api/v1/role-associations/user/{userId}/
-     * @secure
-     */
+ * @description Fetch roles for a user
+ *
+ * @tags role-associations
+ * @name GetApiV1RoleAssociationsUserByUserId
+ * @request GET:/api/v1/role-associations/user/{userId}/
+ * @secure
+ * @response `200` `((({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** Role ID *\
+    id: string,
+  \** The archived status of the role *\
+    archived: boolean,
+  \** The frn of the role *\
+    frn?: string,
+
+}) & {
+    frn: string,
+
+}))[]`
+ */
     getApiV1RoleAssociationsUserByUserId = (userId, query, params = {}) => this.request({
         path: `/api/v1/role-associations/user/${userId}/`,
         method: "GET",
@@ -393,13 +781,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Link a role to a user
-     *
-     * @tags role-associations
-     * @name PostApiV1RoleAssociationsUserByUserId
-     * @request POST:/api/v1/role-associations/user/{userId}/
-     * @secure
-     */
+ * @description Link a role to a user
+ *
+ * @tags role-associations
+ * @name PostApiV1RoleAssociationsUserByUserId
+ * @request POST:/api/v1/role-associations/user/{userId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+}`
+ */
     postApiV1RoleAssociationsUserByUserId = (userId, data, params = {}) => this.request({
         path: `/api/v1/role-associations/user/${userId}/`,
         method: "POST",
@@ -410,13 +807,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Unlink a role from a user
-     *
-     * @tags role-associations
-     * @name DeleteApiV1RoleAssociationsUserByUserId
-     * @request DELETE:/api/v1/role-associations/user/{userId}/
-     * @secure
-     */
+ * @description Unlink a role from a user
+ *
+ * @tags role-associations
+ * @name DeleteApiV1RoleAssociationsUserByUserId
+ * @request DELETE:/api/v1/role-associations/user/{userId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the user *\
+    userId: string,
+
+}`
+ */
     deleteApiV1RoleAssociationsUserByUserId = (userId, data, params = {}) => this.request({
         path: `/api/v1/role-associations/user/${userId}/`,
         method: "DELETE",
@@ -427,13 +833,35 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Fetch roles for a key
-     *
-     * @tags role-associations
-     * @name GetApiV1RoleAssociationsKeyByKeyId
-     * @request GET:/api/v1/role-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Fetch roles for a key
+ *
+ * @tags role-associations
+ * @name GetApiV1RoleAssociationsKeyByKeyId
+ * @request GET:/api/v1/role-associations/key/{keyId}/
+ * @secure
+ * @response `200` `((({
+  \** Organization ID *\
+    organizationId: string,
+  \** Role name *\
+    name: string,
+  \** Role description *\
+    description?: string,
+  \** Flowcore managed role *\
+    flowcoreManaged?: boolean,
+
+} & {
+  \** Role ID *\
+    id: string,
+  \** The archived status of the role *\
+    archived: boolean,
+  \** The frn of the role *\
+    frn?: string,
+
+}) & {
+    frn: string,
+
+}))[]`
+ */
     getApiV1RoleAssociationsKeyByKeyId = (keyId, params = {}) => this.request({
         path: `/api/v1/role-associations/key/${keyId}/`,
         method: "GET",
@@ -442,13 +870,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Link a role to a key
-     *
-     * @tags role-associations
-     * @name PostApiV1RoleAssociationsKeyByKeyId
-     * @request POST:/api/v1/role-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Link a role to a key
+ *
+ * @tags role-associations
+ * @name PostApiV1RoleAssociationsKeyByKeyId
+ * @request POST:/api/v1/role-associations/key/{keyId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+}`
+ */
     postApiV1RoleAssociationsKeyByKeyId = (keyId, data, params = {}) => this.request({
         path: `/api/v1/role-associations/key/${keyId}/`,
         method: "POST",
@@ -459,13 +896,22 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Unlink a role from a key
-     *
-     * @tags role-associations
-     * @name DeleteApiV1RoleAssociationsKeyByKeyId
-     * @request DELETE:/api/v1/role-associations/key/{keyId}/
-     * @secure
-     */
+ * @description Unlink a role from a key
+ *
+ * @tags role-associations
+ * @name DeleteApiV1RoleAssociationsKeyByKeyId
+ * @request DELETE:/api/v1/role-associations/key/{keyId}/
+ * @secure
+ * @response `200` `{
+  \** The ID of the role *\
+    roleId: string,
+  \** The ID of the organization *\
+    organizationId: string,
+  \** The ID of the key *\
+    keyId: string,
+
+}`
+ */
     deleteApiV1RoleAssociationsKeyByKeyId = (keyId, data, params = {}) => this.request({
         path: `/api/v1/role-associations/key/${keyId}/`,
         method: "DELETE",
@@ -476,13 +922,54 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Validate if a user can perform actions
-     *
-     * @tags validate
-     * @name PostApiV1ValidateUsersById
-     * @request POST:/api/v1/validate/users/{id}
-     * @secure
-     */
+ * @description Validate if a user can perform actions
+ *
+ * @tags validate
+ * @name PostApiV1ValidateUsersById
+ * @request POST:/api/v1/validate/users/{id}
+ * @secure
+ * @response `200` `{
+  \**
+   * 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,
+
+})[],
+
+}`
+ * @response `403` `{
+  \** 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)[]),
+
+})[],
+
+}`
+ */
     postApiV1ValidateUsersById = (id, data, params = {}) => this.request({
         path: `/api/v1/validate/users/${id}`,
         method: "POST",
@@ -493,13 +980,54 @@ export class Api extends HttpClient {
         ...params,
     });
     /**
-     * @description Validate if a key can perform actions
-     *
-     * @tags validate
-     * @name PostApiV1ValidateKeysById
-     * @request POST:/api/v1/validate/keys/{id}
-     * @secure
-     */
+ * @description Validate if a key can perform actions
+ *
+ * @tags validate
+ * @name PostApiV1ValidateKeysById
+ * @request POST:/api/v1/validate/keys/{id}
+ * @secure
+ * @response `200` `{
+  \**
+   * 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,
+
+})[],
+
+}`
+ * @response `403` `{
+  \** 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)[]),
+
+})[],
+
+}`
+ */
     postApiV1ValidateKeysById = (id, data, params = {}) => this.request({
         path: `/api/v1/validate/keys/${id}`,
         method: "POST",