@workos/openapi-spec 0.2.0 → 0.3.0

package/open-api-spec.yaml

@@ -1635,6 +1635,27 @@ paths:
             `after` fetches newer records). Defaults to descending.
           schema:
             $ref: '#/components/schemas/PaginationOrder'
+        - name: resource_id
+          required: false
+          in: query
+          description: Filter assignments by the ID of the resource.
+          schema:
+            example: authz_resource_01HXYZ123456789ABCDEFGH
+            type: string
+        - name: resource_external_id
+          required: false
+          in: query
+          description: Filter assignments by the external ID of the resource.
+          schema:
+            example: project-ext-456
+            type: string
+        - name: resource_type_slug
+          required: false
+          in: query
+          description: Filter assignments by the slug of the resource type.
+          schema:
+            example: project
+            type: string
       responses:
         '200':
           description: OK
@@ -3474,6 +3495,13 @@ paths:
             `after` fetches newer records). Defaults to descending.
           schema:
             $ref: '#/components/schemas/PaginationOrder'
+        - name: role_slug
+          required: false
+          in: query
+          description: Filter assignments by the slug of the role.
+          schema:
+            example: editor
+            type: string
       responses:
         '200':
           description: OK
@@ -3984,13 +4012,6 @@ paths:
           schema:
             type: string
             example: ext-workspace-123
-        - name: search
-          required: false
-          in: query
-          description: Search resources by name.
-          schema:
-            type: string
-            example: Website Redesign
       responses:
         '200':
           description: OK
@@ -4778,6 +4799,13 @@ paths:
             `after` fetches newer records). Defaults to descending.
           schema:
             $ref: '#/components/schemas/PaginationOrder'
+        - name: role_slug
+          required: false
+          in: query
+          description: Filter assignments by the slug of the role.
+          schema:
+            example: editor
+            type: string
       responses:
         '200':
           description: OK
@@ -8963,6 +8991,25 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/Group'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  code:
+                    type: string
+                    description: The error code identifying the type of error.
+                    example: group_membership_limit_exceeded
+                    const: group_membership_limit_exceeded
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: Request could not be processed.
+                required:
+                  - code
+                  - message
         '403':
           description: Forbidden
           content:
@@ -9708,8 +9755,8 @@ paths:
           description: >-
             Can be used to pre-fill the username/email address field of the IdP
             sign-in page for the user, if you know their username ahead of time.
-            Currently supported for OAuth, OpenID Connect, Okta, and Entra ID
-            connections.
+            Currently supported for OAuth, OpenID Connect, Okta, Entra ID, and
+            custom SAML connections.
         - name: nonce
           required: false
           in: query

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "WorkOS OpenAPI specification and TypeScript types",
   "license": "MIT",
   "repository": {

package/types.d.ts

@@ -15216,6 +15216,12 @@ export interface operations {
                 limit?: number;
                 /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending. */
                 order?: components["schemas"]["PaginationOrder"];
+                /** @description Filter assignments by the ID of the resource. */
+                resource_id?: string;
+                /** @description Filter assignments by the external ID of the resource. */
+                resource_external_id?: string;
+                /** @description Filter assignments by the slug of the resource type. */
+                resource_type_slug?: string;
             };
             header?: never;
             path: {
@@ -16873,6 +16879,8 @@ export interface operations {
                 limit?: number;
                 /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending. */
                 order?: components["schemas"]["PaginationOrder"];
+                /** @description Filter assignments by the slug of the role. */
+                role_slug?: string;
             };
             header?: never;
             path: {
@@ -17299,8 +17307,6 @@ export interface operations {
                 parent_resource_type_slug?: string;
                 /** @description Filter resources by parent external ID. Required with `parent_resource_type_slug`. Mutually exclusive with `parent_resource_id`. */
                 parent_external_id?: string;
-                /** @description Search resources by name. */
-                search?: string;
             };
             header?: never;
             path?: never;
@@ -17990,6 +17996,8 @@ export interface operations {
                 limit?: number;
                 /** @description Order the results by the creation time. Supported values are `"asc"` (ascending), `"desc"` (descending), and `"normal"` (descending with reversed cursor semantics where `before` fetches older records and `after` fetches newer records). Defaults to descending. */
                 order?: components["schemas"]["PaginationOrder"];
+                /** @description Filter assignments by the slug of the role. */
+                role_slug?: string;
             };
             header?: never;
             path: {
@@ -21908,6 +21916,27 @@ export interface operations {
                     "application/json": components["schemas"]["Group"];
                 };
             };
+            /** @description Bad Request */
+            400: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description The error code identifying the type of error.
+                         * @example group_membership_limit_exceeded
+                         * @constant
+                         */
+                        code: "group_membership_limit_exceeded";
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Request could not be processed.
+                         */
+                        message: string;
+                    };
+                };
+            };
             /** @description Forbidden */
             403: {
                 headers: {
@@ -22409,7 +22438,7 @@ export interface operations {
                 organization?: string;
                 /** @description Can be used to pre-fill the domain field when initiating authentication with Microsoft OAuth or with a Google SAML connection type. */
                 domain_hint?: string;
-                /** @description Can be used to pre-fill the username/email address field of the IdP sign-in page for the user, if you know their username ahead of time. Currently supported for OAuth, OpenID Connect, Okta, and Entra ID connections. */
+                /** @description Can be used to pre-fill the username/email address field of the IdP sign-in page for the user, if you know their username ahead of time. Currently supported for OAuth, OpenID Connect, Okta, Entra ID, and custom SAML connections. */
                 login_hint?: string;
                 /** @description A random string generated by the client that is used to mitigate replay attacks. */
                 nonce?: string;