API Change Log - AdminUser

🧩 Service: AdminUser

🔧 Operation: getAdminUsers

🔹 Change 1

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_REMOVED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.id

🔹 Change 2

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.access.properties.organization

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 4

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PhoneNumber
• Schema Action: REQUIRED_FIELD_REMOVED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.phone_numbers.items.required.4

🔹 Change 5

• Action: remove
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.emails.items.properties.email.format

🔹 Change 6

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Email
• Schema Action: REQUIRED_REMOVED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.emails.items.required

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties._id
• New Schema:

{
  "type": "string",
  "description": "Unique identifier of the user."
}

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.profile_pic
• New Schema:

{
  "type": "string",
  "description": "URL of the profile picture of the user."
}

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.created_at
• New Schema:

{
  "type": "string",
  "x-not-date": true,
  "description": "The date and time when the user was created."
}

🔹 Change 10

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.updated_at
• New Schema:

{
  "type": "string",
  "x-not-date": true,
  "description": "The date and time when the user was last updated."
}

🔹 Change 11

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.items.items.properties.__v
• New Schema:

{
  "type": "number",
  "description": "Version of the document."
}

🔹 Change 12

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUsers.methodTypePlaceHolder.responses.500

🔧 Operation: addAdminUser

🔹 Change 1

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: AddAdminUserSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.addAdminUser.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
• New Schema:

true

🔹 Change 2

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.addAdminUser.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.access.properties.organization

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.addAdminUser.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 4

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.organization

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 6

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
• New Schema:

"date-time"

🔹 Change 7

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
• New Schema:

"date-time"

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AddAdminUserResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.type
• New Schema:

{
  "type": "string",
  "description": "Type of the admin user."
}

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AddAdminUserResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.__v
• New Schema:

{
  "type": "number",
  "description": "Version of the document."
}

🔹 Change 10

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.4XX

🔹 Change 11

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.addAdminUser.methodTypePlaceHolder.responses.5XX

🔧 Operation: getAdminUserByUserId

🔹 Change 1

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
• New Schema:

"date-time"

🔹 Change 2

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUserByUserIdResponseSchema
• Schema Action: NULLABLE_ADDED
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.expire_at.nullable
• New Schema:

true

🔹 Change 3

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.expire_at.format
• New Schema:

"date-time"

🔹 Change 4

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
• New Schema:

"date-time"

🔹 Change 5

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.organization

🔹 Change 6

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 7

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUserByUserIdResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.__v
• New Schema:

{
  "type": "number",
  "description": "Version of the document."
}

🔹 Change 8

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.getAdminUserByUserId.methodTypePlaceHolder.responses.500

🔧 Operation: updateAdminUserAccess

🔹 Change 1

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: EditAdminUserRequestSchema
• Schema Action: ADDITIONAL_PROPERTIES_ADDED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.meta.additionalProperties
• New Schema:

true

🔹 Change 2

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.access.properties.organization

🔹 Change 3

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.requestBody.content.application/json.schema.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 4

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> PartnerAccess
• Schema Action: PROPERTY_REMOVED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.organization

🔹 Change 5

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AdminUsersList --> Access
• Schema Action: PROPERTY_ADDED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.access.properties.company
• New Schema:

{
  "type": "array",
  "items": {
    "type": "number"
  },
  "description": "List of company IDs the user has access to."
}

🔹 Change 6

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.created_at.format
• New Schema:

"date-time"

🔹 Change 7

• Action: add
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.updated_at.format
• New Schema:

"date-time"

🔹 Change 8

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AddAdminUserResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.type
• New Schema:

{
  "type": "string",
  "description": "Type of the admin user."
}

🔹 Change 9

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: AddAdminUserResponseSchema
• Schema Action: PROPERTY_ADDED
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.200.content.application/json.schema.properties.__v
• New Schema:

{
  "type": "number",
  "description": "Version of the document."
}

🔹 Change 10

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.4XX

🔹 Change 11

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.updateAdminUserAccess.methodTypePlaceHolder.responses.5XX

🔧 Operation: removeAdminUser

🔹 Change 1

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.removeAdminUser.methodTypePlaceHolder.responses.4XX

🔹 Change 2

• Action: remove
• Type: breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: N/A
• Path: paths.removeAdminUser.methodTypePlaceHolder.responses.5XX

🔧 Operation: getAdminPermissions

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getAdminPermissions
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Admin Permissions",
    "description": "Retrieve the list of admin permissions available within the platform.",
    "operationId": "getAdminPermissions",
    "tags": [
      "Permissions"
    ],
    "x-groups": [
      "Permissions"
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of admin permissions.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminPermissionList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminPermissionList"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/permissions",
    "methodType": "get"
  }
}

🔧 Operation: searchAdminUsers

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.searchAdminUsers
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Search Admin and Organisation Users",
    "description": "Search for admin and organisation users based on query parameters.",
    "operationId": "searchAdminUsers",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "parameters": [
      {
        "name": "query",
        "in": "query",
        "required": true,
        "schema": {
          "type": "string"
        },
        "description": "The search query to find users.",
        "examples": {
          "success": {
            "value": "search@example.com"
          }
        }
      },
      {
        "name": "org_users",
        "in": "query",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "false"
          ],
          "default": "true"
        },
        "description": "Flag to include organisation users in the search",
        "examples": {
          "success": {
            "value": "false"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of user search results.",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/UserSchema"
              }
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserSchema"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/search",
    "methodType": "get"
  }
}

🔧 Operation: resetAdminUserPassword

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.resetAdminUserPassword
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Reset Admin User Password",
    "description": "Reset the password of an admin user by specifying the username and new password.",
    "operationId": "resetAdminUserPassword",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PasswordResetPayload"
          },
          "examples": {
            "success": {
              "value": {
                "username": "username",
                "password": "NewPassword@1234"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful password reset.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OperationResult"
            },
            "examples": {
              "success": {
                "value": {
                  "message": "success"
                }
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/user/reset-password",
    "methodType": "post"
  }
}

🔧 Operation: createBulkAdminUsers

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.createBulkAdminUsers
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Create Bulk Admin Users",
    "description": "Create multiple admin users in bulk by providing user details.",
    "operationId": "createBulkAdminUsers",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/BulkUserCreation"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/BulkUserCreation"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful creation of bulk admin users.",
        "content": {
          "application/json": {
            "schema": {
              "type": "array",
              "items": {
                "$ref": "#/components/schemas/UserSchema"
              }
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserSchema"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/x-bulk-users",
    "methodType": "post"
  }
}

🔧 Operation: setUserIdCounter

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.setUserIdCounter
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Set User ID Counter",
    "description": "Set the user ID counter to a specified value.",
    "operationId": "setUserIdCounter",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SetUserCount"
          },
          "examples": {
            "success": {
              "value": {
                "count": 1000
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful setting of the user ID counter.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UserCounter"
            },
            "examples": {
              "success": {
                "value": {
                  "_id": "user.uid",
                  "next": 1000
                }
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/set-user-counter",
    "methodType": "post"
  }
}

🔧 Operation: activateDeactivateAdminUsers

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.activateDeactivateAdminUsers
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Activate/Deactivate Admin Users",
    "description": "Activate or deactivate admin users by specifying user IDs and desired status.",
    "operationId": "activateDeactivateAdminUsers",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SetUserActivation"
          },
          "examples": {
            "activate_users_example": {
              "value": {
                "user_id": [
                  "101",
                  "102"
                ],
                "status": true
              }
            },
            "deactivate_users_example": {
              "value": {
                "user_id": [
                  "101"
                ],
                "status": false
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successful activation or deactivation of users.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SuccessResult"
            },
            "examples": {
              "activate_users_example": {
                "value": {
                  "success": true
                }
              },
              "deactivate_users_example": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/user/activation",
    "methodType": "put"
  }
}

🔧 Operation: listAdminUsers

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.listAdminUsers
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "List Admin Users",
    "description": "Retrieve a paginated list of admin users based on query parameters.",
    "operationId": "listAdminUsers",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "parameters": [
      {
        "in": "query",
        "name": "page",
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        },
        "description": "The page number for pagination."
      },
      {
        "in": "query",
        "name": "limit",
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 10
          }
        },
        "description": "The number of items to retrieve per page."
      }
    ],
    "responses": {
      "200": {
        "description": "A paginated list of admin users.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/UserList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/UserList"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/list",
    "methodType": "get"
  }
}

🔧 Operation: deleteAdminUser

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.deleteAdminUser
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Delete Admin User",
    "description": "Delete a user by user ID if the user is inactive.",
    "operationId": "deleteAdminUser",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "parameters": [
      {
        "in": "query",
        "name": "user_id",
        "required": true,
        "description": "The ID of the user to be deleted",
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66ae7c73fd02f1b6dfec2033"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "The user was successfully deleted.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SuccessResult"
            },
            "examples": {
              "success": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/user/delete",
    "methodType": "delete"
  }
}

🔧 Operation: undeleteAdminUser

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.undeleteAdminUser
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Undelete Admin User",
    "description": "Reactivate a user who was previously deleted by their user ID.",
    "operationId": "undeleteAdminUser",
    "tags": [
      "Users"
    ],
    "x-groups": [
      "Users"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UnDeleteUser"
          },
          "examples": {
            "success": {
              "value": {
                "user_id": "66ae813b372347b3f6ea5f46"
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "The user was successfully deleted.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/SuccessResult"
            },
            "examples": {
              "success": {
                "value": {
                  "success": true
                }
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/user-info/user/undelete",
    "methodType": "put"
  }
}

🔧 Operation: getPlatformConfig

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getPlatformConfig
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Platform Configuration",
    "description": "Retrieve the current configuration settings for the platform.",
    "operationId": "getPlatformConfig",
    "tags": [
      "Platform Config"
    ],
    "x-groups": [
      "Platform Config"
    ],
    "responses": {
      "200": {
        "description": "Successfully retrieved platform configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PlatformConfig"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/PlatformConfig"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/platform/config",
    "methodType": "get"
  }
}

🔧 Operation: updatePlatformConfig

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.updatePlatformConfig
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update Platform Configuration",
    "description": "Update the configuration settings for the platform.",
    "operationId": "updatePlatformConfig",
    "tags": [
      "Platform Config"
    ],
    "x-groups": [
      "Platform Config"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PlatformConfig"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/PlatformConfig"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successfully updated platform configuration.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/PlatformConfig"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/PlatformConfig"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/platform/config",
    "methodType": "post"
  }
}

🔧 Operation: listOAuthClients

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.listOAuthClients
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "List OAuth Clients",
    "description": "Retrieve a list of OAuth clients based on query parameters.",
    "operationId": "listOAuthClients",
    "tags": [
      "OAuth Client"
    ],
    "x-groups": [
      "OAuth Client"
    ],
    "parameters": [
      {
        "name": "is_active",
        "in": "query",
        "description": "Filter by active status",
        "required": false,
        "schema": {
          "type": "string",
          "enum": [
            "true",
            "false"
          ]
        },
        "examples": {
          "success": {
            "value": "true"
          }
        }
      },
      {
        "name": "search",
        "in": "query",
        "description": "Search by client name",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "page",
        "in": "query",
        "description": "Page number for pagination",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      },
      {
        "name": "size",
        "in": "query",
        "description": "Number of items per page",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 10
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successfully retrieved list of OAuth clients.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClientList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClientList"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/oauth/client",
    "methodType": "get"
  }
}

🔧 Operation: createOAuthClient

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.createOAuthClient
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Create OAuth Client",
    "description": "Create a new OAuth client for the platform.",
    "operationId": "createOAuthClient",
    "tags": [
      "OAuth Client"
    ],
    "x-groups": [
      "OAuth Client"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/OAuthClient"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/OAuthClientPayload"
            }
          }
        }
      }
    },
    "responses": {
      "201": {
        "description": "Successfully created OAuth client.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/oauth/client",
    "methodType": "post"
  }
}

🔧 Operation: getOAuthClient

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getOAuthClient
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get OAuth Client Details",
    "description": "Retrieve the details of a specific OAuth client by its client ID.",
    "operationId": "getOAuthClient",
    "tags": [
      "OAuth Client"
    ],
    "x-groups": [
      "OAuth Client"
    ],
    "parameters": [
      {
        "name": "client_id",
        "in": "path",
        "description": "The unique identifier of the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66af84abcfa9cf07c34a15ea"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successfully retrieved the OAuth client details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/oauth/client/{client_id}",
    "methodType": "get"
  }
}

🔧 Operation: updateOAuthClient

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.updateOAuthClient
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update OAuth Client Details",
    "description": "Update the details of a specific OAuth client by its client ID.",
    "operationId": "updateOAuthClient",
    "tags": [
      "OAuth Client"
    ],
    "x-groups": [
      "OAuth Client"
    ],
    "parameters": [
      {
        "name": "client_id",
        "in": "path",
        "description": "The unique identifier of the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66af84abcfa9cf07c34a15ea"
          }
        }
      }
    ],
    "requestBody": {
      "description": "The metadata to update for the OAuth client.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/UpdateOAuthClient"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/UpdateOAuthClient"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successfully retrieved the OAuth client details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/oauth/client/{client_id}",
    "methodType": "put"
  }
}

🔧 Operation: deleteOAuthClient

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.deleteOAuthClient
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Delete OAuth Client",
    "description": "Delete a specific OAuth client by its client ID.",
    "operationId": "deleteOAuthClient",
    "tags": [
      "OAuth Client"
    ],
    "x-groups": [
      "OAuth Client"
    ],
    "parameters": [
      {
        "in": "path",
        "name": "client_id",
        "description": "The unique identifier for the OAuth client",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "66af86648dcbdd08ac28d76b"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful deletion of OAuth client.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/OAuthClient"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/OAuthClient"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/oauth/client/{client_id}",
    "methodType": "delete"
  }
}

🔧 Operation: createCustomAdminRole

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.createCustomAdminRole
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Create a Custom Admin Role",
    "description": "Create a new custom admin role with specific permissions and access settings.",
    "operationId": "createCustomAdminRole",
    "tags": [
      "Admin Roles"
    ],
    "x-groups": [
      "Admin Roles"
    ],
    "requestBody": {
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AdminRole"
          },
          "examples": {
            "success": {
              "value": {
                "slug": "test_1",
                "display": "test Access",
                "permissions": [
                  "company",
                  "plans",
                  "admin-access",
                  "product"
                ],
                "access": {
                  "all": false,
                  "company": []
                },
                "partner_access": {
                  "all": false,
                  "organization": []
                }
              }
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successfully created the custom admin role.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminRole"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminRole"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/role",
    "methodType": "post"
  }
}

🔧 Operation: getCustomAdminRoles

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getCustomAdminRoles
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieve Custom Admin Roles",
    "description": "Retrieve a list of custom admin roles, with optional search and filter criteria.",
    "operationId": "getCustomAdminRoles",
    "tags": [
      "Admin Roles"
    ],
    "x-groups": [
      "Admin Roles"
    ],
    "parameters": [
      {
        "name": "q",
        "in": "query",
        "description": "Search query to filter roles by display name",
        "required": false,
        "schema": {
          "type": "string"
        }
      },
      {
        "name": "page",
        "in": "query",
        "description": "Page number for pagination",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 1
          }
        }
      },
      {
        "name": "limit",
        "in": "query",
        "description": "Number of items per page for pagination",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "examples": {
          "success": {
            "value": 10
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successfully retrieved list of custom admin roles.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminRoleList"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminRoleList"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/role",
    "methodType": "get"
  }
}

🔧 Operation: getCustomAdminRole

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getCustomAdminRole
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Retrieve Custom Admin Role by Slug",
    "description": "Retrieve a custom admin role using its unique slug identifier",
    "operationId": "getCustomAdminRole",
    "tags": [
      "Admin Roles"
    ],
    "x-groups": [
      "Admin Roles"
    ],
    "parameters": [
      {
        "name": "role_slug",
        "in": "path",
        "description": "The unique slug identifier of the role to retrieve",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "role_01"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successfully retrieved the custom admin role.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminRole"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminRole"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/role/{role_slug}",
    "methodType": "get"
  }
}

🔧 Operation: updateCustomAdminRole

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.updateCustomAdminRole
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Update Custom Admin Role by Slug",
    "description": "Update the details of a custom admin role using its unique slug identifier.",
    "operationId": "updateCustomAdminRole",
    "tags": [
      "Admin Roles"
    ],
    "x-groups": [
      "Admin Roles"
    ],
    "parameters": [
      {
        "name": "role_slug",
        "in": "path",
        "description": "The unique slug identifier of the role to retrieve",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "role_01"
          }
        }
      }
    ],
    "requestBody": {
      "description": "New details for the custom admin role.",
      "required": true,
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/AdminRole"
          },
          "examples": {
            "success": {
              "$ref": "#/components/examples/AdminRole"
            }
          }
        }
      }
    },
    "responses": {
      "200": {
        "description": "Successfully updated the custom admin role.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminRole"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminRole"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/role/{role_slug}",
    "methodType": "put"
  }
}

🔧 Operation: deleteCustomAdminRole

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.deleteCustomAdminRole
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Delete Custom Admin Role by Slug",
    "description": "Delete a custom admin role using its unique slug identifier.",
    "operationId": "deleteCustomAdminRole",
    "tags": [
      "Admin Roles"
    ],
    "x-groups": [
      "Admin Roles"
    ],
    "parameters": [
      {
        "name": "role_slug",
        "in": "path",
        "description": "The unique slug identifier of the role to retrieve",
        "required": true,
        "schema": {
          "type": "string"
        },
        "examples": {
          "success": {
            "value": "role_02"
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successfully updated the custom admin role.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminRole"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminRole"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/role/{role_slug}",
    "methodType": "delete"
  }
}

🔧 Operation: getCurrentAdminStaffAccess

🔹 Change 1

• Action: add
• Type: non-breaking
• xGroup: N/A
• Schema Ref: N/A
• Schema Action: OPERATION_ID_ADDED
• Path: paths.getCurrentAdminStaffAccess
• New Schema:

{
  "methodTypePlaceHolder": {
    "summary": "Get Current Admin Staff Access",
    "description": "Retrieve the access details and permissions for the current admin staff member",
    "operationId": "getCurrentAdminStaffAccess",
    "tags": [
      "Staff"
    ],
    "x-groups": [
      "Staff"
    ],
    "parameters": [
      {
        "name": "company",
        "in": "query",
        "required": false,
        "schema": {
          "type": "integer"
        },
        "description": "The unique identifier for the company to check access for",
        "examples": {
          "success": {
            "value": 1
          }
        }
      }
    ],
    "responses": {
      "200": {
        "description": "Successful retrieval of admin staff access details.",
        "content": {
          "application/json": {
            "schema": {
              "$ref": "#/components/schemas/AdminStaffAccess"
            },
            "examples": {
              "success": {
                "$ref": "#/components/examples/AdminStaffAccess"
              }
            }
          }
        }
      }
    },
    "path": "/service/___/administrator/authorization/v1.0/admin/staff/current/access",
    "methodType": "get"
  }
}