@canopy-io/node 0.3.8 → 0.3.10

package/dist/index.d.cts

@@ -1733,7 +1733,7 @@ interface paths {
         get: operations["ApiOrganizationDirectoryController_listGrantableRoles"];
         /**
          * Replace the roles an organization's directory may grant
-         * @description Replaces the whole list in one act. Withdrawing a role unmaps the groups that name it and releases the grants those mappings produced. An empty list disables directory sync for the organization.
+         * @description Replaces the whole list in one act. Withdrawing a role unmaps the groups that name it and releases the grants those mappings produced. An empty list removes the organization's own list: it then holds the Environment's identity-provider arrival roles when those are set, and otherwise directory sync is disabled for it, which is refused with `409` while its directory is live.
          */
         put: operations["ApiOrganizationDirectoryController_setGrantableRoles"];
         post?: never;
@@ -3900,10 +3900,20 @@ interface components {
                      */
                     environment_id?: string | null;
                     /**
-                     * @description Set when the change came from an accepted invitation.
+                     * Format: uuid
+                     * @description The SSO connection the identity first signed in through, for one created just in time.
+                     */
+                    connection_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
+                    /**
+                     * @description How the identity was created, when it was not created directly.
                      * @enum {string}
                      */
-                    source?: "invite";
+                    source?: "invite" | "sso_jit" | "scim";
                 };
             };
         };
@@ -3984,11 +3994,16 @@ interface components {
                      * @description The invitation that was accepted.
                      */
                     invite_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                     /**
                      * @description How the membership was created, when known.
                      * @enum {string}
                      */
-                    source?: "identity_create" | "sso_jit" | "invite";
+                    source?: "identity_create" | "sso_jit" | "invite" | "scim";
                 };
             };
         };
@@ -4002,6 +4017,16 @@ interface components {
                 metadata: {
                     /** @description Pending invitations into the Environment revoked with the membership. */
                     revoked_pending_invites: number;
+                    /**
+                     * @description Set when directory sync made the change rather than somebody directly.
+                     * @enum {string}
+                     */
+                    source?: "scim";
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                 };
             };
         };
@@ -4102,6 +4127,16 @@ interface components {
                     succeeded: number;
                     /** @description How many were refused. */
                     failed: number;
+                    /**
+                     * @description Set when directory sync made the change rather than somebody directly.
+                     * @enum {string}
+                     */
+                    source?: "scim";
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                 };
             };
         };
@@ -4133,6 +4168,16 @@ interface components {
                          */
                         role_id: string;
                     }[];
+                    /**
+                     * @description Set when directory sync made the change rather than somebody directly.
+                     * @enum {string}
+                     */
+                    source?: "scim";
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                 };
             };
         };
@@ -4167,6 +4212,250 @@ interface components {
                 };
             };
         };
+        /** @description A delivery of the `scim.user.provisioned` webhook event. */
+        WebhookScimUserProvisionedEvent: {
+            /** @enum {string} */
+            event: "scim.user.provisioned";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "identity";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that pushed the person.
+                     */
+                    directory_id: string;
+                    /** @description The address the provider pushed. */
+                    user_name: string;
+                    /** @description The provider's own id for the person. */
+                    external_id: string | null;
+                    /** @description True when the address already had an identity, which was linked rather than created. */
+                    linked: boolean;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.user.updated` webhook event. */
+        WebhookScimUserUpdatedEvent: {
+            /** @enum {string} */
+            event: "scim.user.updated";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "identity";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that changed the person.
+                     */
+                    directory_id: string;
+                    /** @description The address the provider holds for the person now. */
+                    user_name: string;
+                    /** @description The provider's own id for the person. */
+                    external_id: string | null;
+                    /** @description Whether the person is active in this directory. */
+                    active: boolean;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.user.deprovisioned` webhook event. */
+        WebhookScimUserDeprovisionedEvent: {
+            /** @enum {string} */
+            event: "scim.user.deprovisioned";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "identity";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that deactivated the person.
+                     */
+                    directory_id: string;
+                    /** @description The address the provider held for the person. */
+                    user_name: string;
+                    /** @description The provider's own id for the person. */
+                    external_id: string | null;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.user.reactivated` webhook event. */
+        WebhookScimUserReactivatedEvent: {
+            /** @enum {string} */
+            event: "scim.user.reactivated";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "identity";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that brought the person back.
+                     */
+                    directory_id: string;
+                    /** @description The address the provider holds for the person. */
+                    user_name: string;
+                    /** @description The provider's own id for the person. */
+                    external_id: string | null;
+                    /** @description True when the address already had an identity, which was linked rather than created. */
+                    linked: boolean;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.created` webhook event. */
+        WebhookScimGroupCreatedEvent: {
+            /** @enum {string} */
+            event: "scim.group.created";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that pushed the group.
+                     */
+                    directory_id: string;
+                    /** @description The group's name. */
+                    display_name: string;
+                    /** @description The provider's own id for the group. */
+                    external_id: string | null;
+                    /** @description How many of its members this directory holds. */
+                    member_count: number;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.updated` webhook event. */
+        WebhookScimGroupUpdatedEvent: {
+            /** @enum {string} */
+            event: "scim.group.updated";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that changed the group.
+                     */
+                    directory_id: string;
+                    /** @description The group's name now. */
+                    display_name: string;
+                    /** @description The provider's own id for the group. */
+                    external_id: string | null;
+                    /** @description How many of its members this directory holds now. */
+                    member_count: number;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.deleted` webhook event. */
+        WebhookScimGroupDeletedEvent: {
+            /** @enum {string} */
+            event: "scim.group.deleted";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory that removed the group.
+                     */
+                    directory_id: string;
+                    /** @description The group's name. */
+                    display_name: string;
+                    /** @description The provider's own id for the group. */
+                    external_id: string | null;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.member_added` webhook event. */
+        WebhookScimGroupMemberAddedEvent: {
+            /** @enum {string} */
+            event: "scim.group.member_added";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory the group belongs to.
+                     */
+                    directory_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The person added.
+                     */
+                    identity_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The directory's own id for the person.
+                     */
+                    directory_user_id: string;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.member_removed` webhook event. */
+        WebhookScimGroupMemberRemovedEvent: {
+            /** @enum {string} */
+            event: "scim.group.member_removed";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory the group belongs to.
+                     */
+                    directory_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The person removed.
+                     */
+                    identity_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The directory's own id for the person.
+                     */
+                    directory_user_id: string;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.mapped` webhook event. */
+        WebhookScimGroupMappedEvent: {
+            /** @enum {string} */
+            event: "scim.group.mapped";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory the group belongs to.
+                     */
+                    directory_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The role the group's members now hold.
+                     */
+                    role_id: string;
+                    /**
+                     * Format: uuid
+                     * @description The node they hold it at.
+                     */
+                    application_node_id: string;
+                };
+            };
+        };
+        /** @description A delivery of the `scim.group.unmapped` webhook event. */
+        WebhookScimGroupUnmappedEvent: {
+            /** @enum {string} */
+            event: "scim.group.unmapped";
+            data: components["schemas"]["ChangeEventDataDto"] & {
+                /** @enum {string} */
+                resource_type: "scim_group";
+                metadata: {
+                    /**
+                     * Format: uuid
+                     * @description The directory the group belongs to.
+                     */
+                    directory_id: string;
+                };
+            };
+        };
         /** @description A delivery of the `role.created` webhook event. */
         WebhookRoleCreatedEvent: {
             /** @enum {string} */
@@ -4480,11 +4769,16 @@ interface components {
                      * @description The invitation that was accepted.
                      */
                     invite_id?: string;
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                     /**
                      * @description How the member joined, when it was not added directly.
                      * @enum {string}
                      */
-                    source?: "sso_jit" | "invite";
+                    source?: "sso_jit" | "invite" | "scim";
                 };
             };
         };
@@ -4513,6 +4807,16 @@ interface components {
                      * @description The role it holds now.
                      */
                     to_role_id: string;
+                    /**
+                     * @description Set when directory sync made the change rather than somebody directly.
+                     * @enum {string}
+                     */
+                    source?: "scim";
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                 };
             };
         };
@@ -4538,6 +4842,16 @@ interface components {
                     role_id: string;
                     /** @description Grants it held beneath the organization, removed with the membership. */
                     scoped_assignments_removed: number;
+                    /**
+                     * @description Set when directory sync made the change rather than somebody directly.
+                     * @enum {string}
+                     */
+                    source?: "scim";
+                    /**
+                     * Format: uuid
+                     * @description The directory that made the change, when directory sync did.
+                     */
+                    directory_id?: string | null;
                 };
             };
         };
@@ -17402,9 +17716,11 @@ declare class Organizations {
      * Replace the list in one act, which is how directory sync is opened for
      * an organization. Exactly one role is `default_role_id`, the one people
      * arrive with. Withdrawing a role unmaps the groups naming it and keeps
-     * their members in the organization; an empty list is refused while a
-     * directory is connected. Your API key only: an organization admin's
-     * token can read the list but is refused changing it.
+     * their members in the organization. An empty list removes the
+     * organization's own list: it then holds the Environment's list when one
+     * is set, and otherwise directory sync closes for it, which is refused
+     * while a directory is connected. Your API key only: an organization
+     * admin's token can read the list but is refused changing it.
      */
     setDirectoryGrantableRoles(id: string, input: RequestBody<"ApiOrganizationDirectoryController_setGrantableRoles">): Promise<ResponseBody<"ApiOrganizationDirectoryController_setGrantableRoles">>;
     /**