@workos/openapi-spec 0.126.0 → 0.128.0

package/dist/open-api-spec.yaml

@@ -1795,6 +1795,47 @@ paths:
       summary: Get an agent registration
       tags:
         - agents.registrations
+  /agents/registrations/{id}/revoke:
+    post:
+      description: >-
+        Revoke an agent registration by ID. Revocation is permanent: the
+        registration, its identity assertions, and every access token or API key
+        issued from it stop working, and the agent must register again. Revoking
+        an already revoked registration succeeds and returns the original
+        `revoked_at`. The registration is scoped to the environment of the API
+        key used to authenticate the request.
+      operationId: AgentAdminController_revokeRegistration
+      parameters:
+        - name: id
+          required: true
+          in: path
+          description: The unique ID of the agent registration.
+          schema:
+            type: string
+            example: agent_reg_01EHWNCE74X7JSDV0X3SZ3KJNY
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/AgentRegistration'
+        '404':
+          description: Not Found
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  message:
+                    type: string
+                    description: A human-readable description of the error.
+                    example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
+                required:
+                  - message
+      summary: Revoke an agent registration
+      tags:
+        - agents.registrations
   /agents/sessions:
     get:
       description: >-
@@ -18129,7 +18170,7 @@ paths:
                     example: 'Organization not found: ''org_01EHQMYV6MBK39QC5PZXHY59C3''.'
                 required:
                   - message
-      summary: Revoke Portal Links
+      summary: Revoke a Portal Link
       tags:
         - admin-portal
   /radar/attempts:
@@ -32526,6 +32567,15 @@ components:
             - revoked
           description: The current verification status of the registration.
           example: verified
+        revoked_at:
+          type:
+            - string
+            - 'null'
+          format: date-time
+          description: >-
+            The timestamp when the registration was revoked, or `null` if it has
+            not been revoked.
+          example: null
         kind:
           type: string
           enum:
@@ -32622,6 +32672,7 @@ components:
         - agent_identity
         - organization_id
         - status
+        - revoked_at
         - kind
         - claim
         - created_at
@@ -41513,6 +41564,34 @@ components:
                               example:
                                 - beta
                                 - release
+                            owner:
+                              description: >-
+                                The previous owner of the flag, or `null` if it
+                                had none.
+                              oneOf:
+                                - type: object
+                                  properties:
+                                    email:
+                                      type: string
+                                      description: The email address of the flag owner.
+                                      example: jane@example.com
+                                    first_name:
+                                      type:
+                                        - string
+                                        - 'null'
+                                      description: The first name of the flag owner.
+                                      example: Jane
+                                    last_name:
+                                      type:
+                                        - string
+                                        - 'null'
+                                      description: The last name of the flag owner.
+                                      example: Doe
+                                  required:
+                                    - email
+                                    - first_name
+                                    - last_name
+                                - type: 'null'
                             enabled:
                               type: boolean
                               description: Whether the flag was previously enabled.

package/dist/services.mjs

@@ -101,6 +101,11 @@ const serviceEndpoints = {
 			"path": "/agents/registrations/{id}",
 			"name": "get_registration"
 		},
+		{
+			"method": "POST",
+			"path": "/agents/registrations/{id}/revoke",
+			"name": "revoke_registration"
+		},
 		{
 			"method": "GET",
 			"path": "/agents/sessions",

package/dist/types.d.ts

@@ -200,6 +200,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/agents/registrations/{id}/revoke": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /**
+         * Revoke an agent registration
+         * @description Revoke an agent registration by ID. Revocation is permanent: the registration, its identity assertions, and every access token or API key issued from it stop working, and the agent must register again. Revoking an already revoked registration succeeds and returns the original `revoked_at`. The registration is scoped to the environment of the API key used to authenticate the request.
+         */
+        post: operations["AgentAdminController_revokeRegistration"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/agents/sessions": {
         parameters: {
             query?: never;
@@ -2449,7 +2469,7 @@ export interface paths {
         get?: never;
         put?: never;
         /**
-         * Revoke Portal Links
+         * Revoke a Portal Link
          * @description Revokes every Portal Link generated for the given organization with the given `external_user_id`, and immediately ends any Admin Portal sessions that were started from those links. Use this when an admin is deprovisioned from your application: unopened links stop working, and their already-open portal sessions are ended. Only links that were generated with an `external_user_id` can be revoked, so pass one to `generate_link` for every admin you may later need to deprovision.
          */
         post: operations["PortalSessionsController_revokeLink"];
@@ -6755,6 +6775,12 @@ export interface components {
              * @enum {string}
              */
             status: "unverified" | "verified" | "expired" | "revoked";
+            /**
+             * Format: date-time
+             * @description The timestamp when the registration was revoked, or `null` if it has not been revoked.
+             * @example null
+             */
+            revoked_at: string | null;
             /**
              * @description The kind of agent registration.
              * @example service_auth
@@ -13584,6 +13610,24 @@ export interface components {
                          *     ]
                          */
                         tags?: string[];
+                        /** @description The previous owner of the flag, or `null` if it had none. */
+                        owner?: {
+                            /**
+                             * @description The email address of the flag owner.
+                             * @example jane@example.com
+                             */
+                            email: string;
+                            /**
+                             * @description The first name of the flag owner.
+                             * @example Jane
+                             */
+                            first_name: string | null;
+                            /**
+                             * @description The last name of the flag owner.
+                             * @example Doe
+                             */
+                            last_name: string | null;
+                        } | null;
                         /**
                          * @description Whether the flag was previously enabled.
                          * @example true
@@ -21979,6 +22023,44 @@ export interface operations {
             };
         };
     };
+    AgentAdminController_revokeRegistration: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path: {
+                /** @description The unique ID of the agent registration. */
+                id: string;
+            };
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description OK */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["AgentRegistration"];
+                };
+            };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        /**
+                         * @description A human-readable description of the error.
+                         * @example Organization not found: 'org_01EHQMYV6MBK39QC5PZXHY59C3'.
+                         */
+                        message: string;
+                    };
+                };
+            };
+        };
+    };
     AgentInstanceSessionsController_list: {
         parameters: {
             query?: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@workos/openapi-spec",
-  "version": "0.126.0",
+  "version": "0.128.0",
   "type": "module",
   "description": "WorkOS OpenAPI specification, TypeScript types, and SDK resolution policy",
   "license": "MIT",