@opusdns/api 1.16.0 → 1.18.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^1.2.0"
   },
   "name": "@opusdns/api",
-  "version": "1.16.0",
+  "version": "1.18.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -67,6 +67,7 @@ import type {
   MetricsGrouping,
   ObjectEventType,
   ObjectLogSortField,
+  OrganizationCredentialStatus,
   OrganizationSortField,
   OrganizationStatus,
   ParkingSortField,
@@ -1224,6 +1225,18 @@ export const OBJECT_LOG_SORT_FIELD_VALUES = [
   'performed_by_id',
 ] as const satisfies ReadonlyArray<ObjectLogSortField>;
 
+export const ORGANIZATION_CREDENTIAL_STATUS = {
+  ACTIVE: "active",
+  EXPIRED: "expired",
+  REVOKED: "revoked",
+} as const satisfies Record<string, OrganizationCredentialStatus>;
+
+export const ORGANIZATION_CREDENTIAL_STATUS_VALUES = [
+  'active',
+  'expired',
+  'revoked',
+] as const satisfies ReadonlyArray<OrganizationCredentialStatus>;
+
 export const ORGANIZATION_SORT_FIELD = {
   CREATED_ON: "created_on",
   NAME: "name",

package/src/helpers/keys.ts

@@ -241,6 +241,7 @@ import type {
   OrganizationAttribute2,
   OrganizationAttributeUpdate,
   OrganizationCreate,
+  OrganizationCredential,
   OrganizationToken,
   OrganizationUpdate,
   OrganizationWithBillingData,
@@ -3463,6 +3464,30 @@ export const KEYS_ORGANIZATION_CREATE = [
   KEY_ORGANIZATION_CREATE_USERS,
 ] as const satisfies (keyof OrganizationCreate)[];
 
+export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_DESCRIPTION = 'api_key_description' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_ID = 'api_key_id' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_API_KEY_NAME = 'api_key_name' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_CREATED_ON = 'created_on' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_DELETED_ON = 'deleted_on' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_EXPIRES_AT = 'expires_at' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_LAST_USED_ON = 'last_used_on' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_ORGANIZATION_ID = 'organization_id' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_ROLE = 'role' satisfies keyof OrganizationCredential;
+export const KEY_ORGANIZATION_CREDENTIAL_STATUS = 'status' satisfies keyof OrganizationCredential;
+
+export const KEYS_ORGANIZATION_CREDENTIAL = [
+  KEY_ORGANIZATION_CREDENTIAL_API_KEY_DESCRIPTION,
+  KEY_ORGANIZATION_CREDENTIAL_API_KEY_ID,
+  KEY_ORGANIZATION_CREDENTIAL_API_KEY_NAME,
+  KEY_ORGANIZATION_CREDENTIAL_CREATED_ON,
+  KEY_ORGANIZATION_CREDENTIAL_DELETED_ON,
+  KEY_ORGANIZATION_CREDENTIAL_EXPIRES_AT,
+  KEY_ORGANIZATION_CREDENTIAL_LAST_USED_ON,
+  KEY_ORGANIZATION_CREDENTIAL_ORGANIZATION_ID,
+  KEY_ORGANIZATION_CREDENTIAL_ROLE,
+  KEY_ORGANIZATION_CREDENTIAL_STATUS,
+] as const satisfies (keyof OrganizationCredential)[];
+
 export const KEY_ORGANIZATION_TOKEN_ACCESS_TOKEN = 'access_token' satisfies keyof OrganizationToken;
 export const KEY_ORGANIZATION_TOKEN_EXPIRES_IN = 'expires_in' satisfies keyof OrganizationToken;
 export const KEY_ORGANIZATION_TOKEN_TOKEN_TYPE = 'token_type' satisfies keyof OrganizationToken;

package/src/helpers/requests.d.ts

@@ -166,6 +166,9 @@ export type GET_ArchiveRequestHistory_Request = {
 };
 export type GET_ArchiveRequestHistory_Request_Query = GET_ArchiveRequestHistory_Request['parameters']['query'];
 
+export type GET_AuthClientCredentialsIntrospect_Request = {
+};
+
 export type POST_AuthToken_Request = {
   requestBody: PublicAuthRequestForm;
 };

package/src/helpers/responses.d.ts

@@ -56,6 +56,7 @@ import type {
   ObjectTagChanges2,
   Organization,
   OrganizationAttribute2,
+  OrganizationCredential,
   OrganizationWithBillingData,
   Pagination_BillingTransaction,
   Pagination_Contact,
@@ -306,6 +307,12 @@ export type GET_ArchiveRequestHistory_Response = GET_ArchiveRequestHistory_Respo
 export type GET_ArchiveRequestHistory_Response_200 = Pagination_RequestHistory;
 export type GET_ArchiveRequestHistory_Response_422 = HTTPValidationError;
 
+export type GET_AuthClientCredentialsIntrospect_Response = GET_AuthClientCredentialsIntrospect_Response_200 | GET_AuthClientCredentialsIntrospect_Response_401 | GET_AuthClientCredentialsIntrospect_Response_422;
+
+export type GET_AuthClientCredentialsIntrospect_Response_200 = OrganizationCredential;
+export type GET_AuthClientCredentialsIntrospect_Response_401 = Problem;
+export type GET_AuthClientCredentialsIntrospect_Response_422 = HTTPValidationError;
+
 export type GET_Availability_Response = GET_Availability_Response_200 | GET_Availability_Response_401 | GET_Availability_Response_422;
 
 export type GET_Availability_Response_200 = DomainAvailabilityList;
@@ -1278,8 +1285,9 @@ export type PUT_HostsByHostReference_Response_403 = Problem;
 export type PUT_HostsByHostReference_Response_404 = Problem;
 export type PUT_HostsByHostReference_Response_422 = HTTPValidationError;
 
-export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_422;
+export type PUT_UsersByUserIdRole_Response = PUT_UsersByUserIdRole_Response_200 | PUT_UsersByUserIdRole_Response_403 | PUT_UsersByUserIdRole_Response_404 | PUT_UsersByUserIdRole_Response_422;
 
 export type PUT_UsersByUserIdRole_Response_200 = PublicRoleAssignment;
 export type PUT_UsersByUserIdRole_Response_403 = Problem;
+export type PUT_UsersByUserIdRole_Response_404 = Problem;
 export type PUT_UsersByUserIdRole_Response_422 = HTTPValidationError;

package/src/helpers/schemas.d.ts

@@ -69,6 +69,7 @@ export type CreateJobBatch = components['schemas']['CreateJobBatchResponse'];
 export type CreateReportReq = components['schemas']['CreateReportReq'];
 export type Currency = components['schemas']['Currency'];
 export type CustomRoleCreate = components['schemas']['CustomRoleCreate'];
+export type CustomRoleLabel = components['schemas']['CustomRoleLabel'];
 export type CustomRoleUpdate = components['schemas']['CustomRoleUpdate'];
 export type DeletePolicyType = components['schemas']['DeletePolicyType'];
 export type DnsChangeAction = components['schemas']['DnsChangeAction'];
@@ -313,6 +314,8 @@ export type OrganizationAttributeCreate = components['schemas']['OrganizationAtt
 export type OrganizationAttribute2 = components['schemas']['OrganizationAttributeResponse'];
 export type OrganizationAttributeUpdate = components['schemas']['OrganizationAttributeUpdate'];
 export type OrganizationCreate = components['schemas']['OrganizationCreate'];
+export type OrganizationCredential = components['schemas']['OrganizationCredential'];
+export type OrganizationCredentialStatus = components['schemas']['OrganizationCredentialStatus'];
 export type OrganizationSortField = components['schemas']['OrganizationSortField'];
 export type OrganizationStatus = components['schemas']['OrganizationStatus'];
 export type OrganizationToken = components['schemas']['OrganizationTokenResponse'];

package/src/openapi.yaml

@@ -2174,6 +2174,8 @@ components:
       - permissions
       title: CustomRoleCreate
       type: object
+    CustomRoleLabel:
+      type: string
     CustomRoleUpdate:
       description: 'Request body for updating a custom role. Omitted fields are left
         unchanged; `permissions`
@@ -8443,6 +8445,87 @@ components:
       - name
       title: OrganizationCreate
       type: object
+    OrganizationCredential:
+      properties:
+        api_key_description:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Description of the organization credential.
+          title: Api Key Description
+        api_key_id:
+          description: Unique identifier of the organization credential.
+          examples:
+          - api_key_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^api_key_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Api Key Id
+          type: string
+          x-typeid-prefix: api_key
+        api_key_name:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Name of the organization credential. Only a-z, A-Z, 0-9, underscore,
+            and hyphen are allowed.
+          title: Api Key Name
+        created_on:
+          description: The date/time the entry was created on
+          format: date-time
+          title: Created On
+          type: string
+        deleted_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date/time the entry was deleted on
+          title: Deleted On
+        expires_at:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date and time the credential expiration.
+          title: Expires At
+        last_used_on:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          description: The date/time the entry was deleted on
+          title: Last Used On
+        organization_id:
+          default: None
+          examples:
+          - organization_01h45ytscbebyvny4gc8cr8ma2
+          format: typeid
+          pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
+          title: Organization Id
+          type: string
+          x-typeid-prefix: organization
+        role:
+          anyOf:
+          - $ref: '#/components/schemas/PublicRole'
+          - $ref: '#/components/schemas/CustomRoleLabel'
+          - type: 'null'
+          title: Role
+        status:
+          $ref: '#/components/schemas/OrganizationCredentialStatus'
+          description: The status of the organization credential.
+          readOnly: true
+      required:
+      - api_key_id
+      - status
+      title: OrganizationCredential
+      type: object
+    OrganizationCredentialStatus:
+      enum:
+      - active
+      - expired
+      - revoked
+      title: OrganizationCredentialStatus
+      type: string
     OrganizationSortField:
       enum:
       - created_on
@@ -10022,7 +10105,9 @@ components:
         role:
           anyOf:
           - $ref: '#/components/schemas/PublicRole'
+          - $ref: '#/components/schemas/CustomRoleLabel'
           - type: 'null'
+          title: Role
       title: PublicRoleAssignment
       type: object
     PublicRoleAssignmentRequest:
@@ -10030,7 +10115,9 @@ components:
         role:
           anyOf:
           - $ref: '#/components/schemas/AssignablePublicRole'
+          - $ref: '#/components/schemas/CustomRoleLabel'
           - type: 'null'
+          title: Role
       title: PublicRoleAssignmentRequest
       type: object
     PublicRoleDefinition:
@@ -10055,10 +10142,9 @@ components:
           description: Description of the role.
           title: Description
         label:
+          $ref: '#/components/schemas/CustomRoleLabel'
           description: Per-organization unique identifier (snake_case, e.g. 'support_staff').
             Used as the URL path parameter.
-          title: Label
-          type: string
         name:
           description: Display name of the role (e.g. 'Support Staff').
           title: Name
@@ -11677,7 +11763,9 @@ components:
         role:
           anyOf:
           - $ref: '#/components/schemas/PublicRole'
+          - $ref: '#/components/schemas/CustomRoleLabel'
           - type: 'null'
+          title: Role
         status:
           $ref: '#/components/schemas/UserStatus'
           readOnly: true
@@ -11881,7 +11969,9 @@ components:
         role:
           anyOf:
           - $ref: '#/components/schemas/PublicRole'
+          - $ref: '#/components/schemas/CustomRoleLabel'
           - type: 'null'
+          title: Role
         status:
           $ref: '#/components/schemas/UserStatus'
           readOnly: true
@@ -12252,7 +12342,7 @@ info:
     \n\n"
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-06-16-085537
+  version: 2026-06-17-145023
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14040,6 +14130,43 @@ paths:
       summary: Retrieve request history logs
       tags:
       - archive
+  /v1/auth/client_credentials/introspect:
+    get:
+      description: Returns the stored record for the API key (or organization token)
+        used to authenticate the request, including its organization. Requires API-key
+        or organization-token authentication; user tokens are rejected.
+      operationId: introspect_client_credential_v1_auth_client_credentials_introspect_get
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OrganizationCredential'
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Introspect the current API key
+      tags:
+      - authentication
   /v1/auth/token:
     post:
       operationId: issue_organization_token_v1_auth_token_post
@@ -27119,7 +27246,8 @@ paths:
       x-required-permissions:
       - users:read
     put:
-      description: Set the role for a user, replacing any existing role
+      description: Set the role for a user, replacing any existing role. Accepts a
+        built-in role name or the label of a custom role owned by the user's organization
       operationId: set_user_role_v1_users__user_id__role_put
       parameters:
       - in: path
@@ -27158,6 +27286,19 @@ paths:
               schema:
                 $ref: '#/components/schemas/Problem'
           description: Forbidden
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_ROLE_NOT_FOUND
+                detail: Role not found
+                role_name: support_staff
+                status: 404
+                title: Role Management Error
+                type: role-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
         '422':
           content:
             application/problem+json:

package/src/schema.d.ts

@@ -255,6 +255,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/auth/client_credentials/introspect": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * Introspect the current API key
+         * @description Returns the stored record for the API key (or organization token) used to authenticate the request, including its organization. Requires API-key or organization-token authentication; user tokens are rejected.
+         */
+        get: operations["introspect_client_credential_v1_auth_client_credentials_introspect_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/auth/token": {
         parameters: {
             query?: never;
@@ -2550,7 +2570,7 @@ export interface paths {
         get: operations["get_role_v1_users__user_id__role_get"];
         /**
          * Set user role
-         * @description Set the role for a user, replacing any existing role
+         * @description Set the role for a user, replacing any existing role. Accepts a built-in role name or the label of a custom role owned by the user's organization
          */
         put: operations["set_user_role_v1_users__user_id__role_put"];
         post?: never;
@@ -4087,6 +4107,7 @@ export interface components {
              */
             permissions: components["schemas"]["PublicPermission"][];
         };
+        CustomRoleLabel: string;
         /**
          * CustomRoleUpdate
          * @description Request body for updating a custom role. Omitted fields are left unchanged; `permissions`
@@ -8201,6 +8222,63 @@ export interface components {
              */
             users?: components["schemas"]["UserCreate"][];
         };
+        /** OrganizationCredential */
+        OrganizationCredential: {
+            /**
+             * Api Key Description
+             * @description Description of the organization credential.
+             */
+            api_key_description?: string | null;
+            /**
+             * Api Key Id
+             * Format: typeid
+             * @description Unique identifier of the organization credential.
+             * @example api_key_01h45ytscbebyvny4gc8cr8ma2
+             */
+            api_key_id: TypeId<"api_key">;
+            /**
+             * Api Key Name
+             * @description Name of the organization credential. Only a-z, A-Z, 0-9, underscore, and hyphen are allowed.
+             */
+            api_key_name?: string | null;
+            /**
+             * Created On
+             * Format: date-time
+             * @description The date/time the entry was created on
+             */
+            created_on?: Date;
+            /**
+             * Deleted On
+             * @description The date/time the entry was deleted on
+             */
+            deleted_on?: Date | null;
+            /**
+             * Expires At
+             * @description The date and time the credential expiration.
+             */
+            expires_at?: Date | null;
+            /**
+             * Last Used On
+             * @description The date/time the entry was deleted on
+             */
+            last_used_on?: Date | null;
+            /**
+             * Organization Id
+             * Format: typeid
+             * @default None
+             * @example organization_01h45ytscbebyvny4gc8cr8ma2
+             */
+            organization_id: TypeId<"organization">;
+            /** Role */
+            role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
+            /** @description The status of the organization credential. */
+            readonly status: components["schemas"]["OrganizationCredentialStatus"];
+        };
+        /**
+         * OrganizationCredentialStatus
+         * @enum {string}
+         */
+        OrganizationCredentialStatus: "active" | "expired" | "revoked";
         /**
          * OrganizationSortField
          * @enum {string}
@@ -9193,11 +9271,13 @@ export interface components {
         PublicRole: "owner" | "admin" | "viewer" | "domain_manager" | "dns_manager" | "billing_manager";
         /** PublicRoleAssignment */
         PublicRoleAssignment: {
-            role?: components["schemas"]["PublicRole"] | null;
+            /** Role */
+            role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
         };
         /** PublicRoleAssignmentRequest */
         PublicRoleAssignmentRequest: {
-            role?: components["schemas"]["AssignablePublicRole"] | null;
+            /** Role */
+            role?: components["schemas"]["AssignablePublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
         };
         /**
          * PublicRoleDefinition
@@ -9219,11 +9299,8 @@ export interface components {
              * @description Description of the role.
              */
             description?: string | null;
-            /**
-             * Label
-             * @description Per-organization unique identifier (snake_case, e.g. 'support_staff'). Used as the URL path parameter.
-             */
-            label: string;
+            /** @description Per-organization unique identifier (snake_case, e.g. 'support_staff'). Used as the URL path parameter. */
+            label: components["schemas"]["CustomRoleLabel"];
             /**
              * Name
              * @description Display name of the role (e.g. 'Support Staff').
@@ -10350,7 +10427,8 @@ export interface components {
              * @example +1.2125552368
              */
             phone?: string | null;
-            role?: components["schemas"]["PublicRole"] | null;
+            /** Role */
+            role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
             readonly status: components["schemas"]["UserStatus"];
             /**
              * Updated On
@@ -10497,7 +10575,8 @@ export interface components {
              * @example +1.2125552368
              */
             phone?: string | null;
-            role?: components["schemas"]["PublicRole"] | null;
+            /** Role */
+            role?: components["schemas"]["PublicRole"] | components["schemas"]["CustomRoleLabel"] | null;
             readonly status: components["schemas"]["UserStatus"];
             /**
              * Updated On
@@ -12149,6 +12228,51 @@ export interface operations {
             };
         };
     };
+    introspect_client_credential_v1_auth_client_credentials_introspect_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrganizationCredential"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     issue_organization_token_v1_auth_token_post: {
         parameters: {
             query?: never;
@@ -22109,6 +22233,23 @@ export interface operations {
                     "application/problem+json": components["schemas"]["Problem"];
                 };
             };
+            /** @description Not Found */
+            404: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_ROLE_NOT_FOUND",
+                     *       "detail": "Role not found",
+                     *       "role_name": "support_staff",
+                     *       "status": 404,
+                     *       "title": "Role Management Error",
+                     *       "type": "role-not-found"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
             /** @description Validation Error */
             422: {
                 headers: {