| Open API (Swagger) Integration for Confluence |
|---|
{
"openapi": "3.1.1",
"info": {
"title": "Julia API",
"description": "API for Cyberzone.Julia, providing authentication and authorization services",
"contact": {
"name": "Anton Babenko",
"url": "https://t.me/saph1s",
"email": "saph1s@cyberzone.dev"
},
"version": "0.1112.30"
},
"servers": [
{
"url": "https://auth.mirea.app/"
}
],
"paths": {
"/v1/admin/client-applications": {
"get": {
"tags": [
"Admin"
],
"summary": "Get Client Applications",
"description": "Returns a list of all client applications configured in the system.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ClientApplicationResponse"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
},
"post": {
"tags": [
"Admin"
],
"summary": "Create Client Application",
"description": "Creates a new client application.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientApplicationCreateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientApplicationResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/auth/oauth/callback/{provider}": {
"get": {
"tags": [
"OAuth Authentication"
],
"summary": "Handle Authentication Callback",
"description": "Handles the callback from the authentication service after the user has logged in.\nThe provider in the route decides which identity source reads the callback.",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"302": {
"description": "Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
}
},
"security": [ ]
}
},
"/v1/auth/oauth/logout/{provider}": {
"post": {
"tags": [
"OAuth Authentication"
],
"summary": "Back-Channel Logout",
"description": "Receives a logout token from the identity provider and ends the sessions that were opened from the provider session it names.",
"parameters": [
{
"name": "provider",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
}
},
"security": [ ]
}
},
"/v1/auth/oauth/exchange": {
"post": {
"tags": [
"OAuth Authentication"
],
"summary": "Exchange Trade Code for JWT Tokens",
"description": "Exchanges a temporary trade code for JWT access and refresh tokens.\nThe trade code is obtained from the authentication callback and must be used within 5 minutes",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ExchangeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
}
}
},
"security": [ ]
}
},
"/v1/auth/refresh": {
"post": {
"tags": [
"Authentication and Authorization"
],
"summary": "Refresh Authentication Token",
"description": "Refreshes the authentication token using the provided refresh token in the request body.\nRequires a valid refresh token in the request body.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RefreshTokenRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LoginResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
}
},
"security": [ ]
}
},
"/v1/auth/publickey": {
"get": {
"tags": [
"Authentication and Authorization"
],
"summary": "Get Public Key",
"description": "Returns the public key used for JWT token verification.\nYou can specify the type of key to return: 'base64' or 'pem'.",
"parameters": [
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"default": "base64"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"type": "string"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [ ]
}
},
"/v1/auth/expired": {
"get": {
"tags": [
"Authentication and Authorization"
],
"summary": "Get Expired Tokens List",
"description": "Returns a list of expired tokens (blacklisted JTI values)",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/auth/logout": {
"post": {
"tags": [
"Authentication and Authorization"
],
"summary": "Logout User",
"description": "Logs out the user by revoking their session.\nRequires a valid JWT token in the Authorization header.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"oneOf": [
{
"type": "null"
},
{
"$ref": "#/components/schemas/LogoutRequest"
}
]
}
}
}
},
"responses": {
"204": {
"description": "No Content"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/v1/auth/redirect": {
"get": {
"tags": [
"Authentication and Authorization"
],
"summary": "Redirect to Authentication Service",
"description": "Redirects the user to the specified authentication service for login.\nThe sourceId is used to retrieve the callback URL for the authentication initiator.",
"parameters": [
{
"name": "sourceId",
"in": "query",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "service",
"in": "query",
"schema": {
"type": "string",
"default": "authentik"
}
}
],
"responses": {
"302": {
"description": "Found"
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
}
},
"security": [ ]
}
},
"/v1/webhooks/debug": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Debug Endpoint",
"description": "Endpoint to debug incoming webhook data",
"requestBody": {
"content": {
"application/json": {
"schema": { }
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Api Token": [ ]
}
]
}
},
"/v1/webhooks/authentik": {
"post": {
"tags": [
"Webhooks"
],
"summary": "Authentik Webhook",
"description": "Endpoint to receive webhooks from Authentik",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuthentikWebhook"
}
}
},
"required": true
},
"responses": {
"204": {
"description": "No Content"
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Api Token": [ ]
}
]
}
},
"/v1/users/@me": {
"get": {
"tags": [
"Users"
],
"summary": "Get current user profile",
"description": "Get the profile of the currently authenticated user.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGetResponse"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/@me/preferences": {
"patch": {
"tags": [
"Users"
],
"summary": "Update current user preferences",
"description": "Update the preferences of the currently authenticated user.",
"responses": {
"501": {
"description": "Not Implemented"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users": {
"get": {
"tags": [
"Users"
],
"summary": "Get user profile by username",
"description": "Get the profile of a user by their username. Accessible anonymously: the owner or an admin receives the full profile, everyone else (including anonymous callers) receives the public view.",
"parameters": [
{
"name": "username",
"in": "query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGetResponsePublic"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
}
},
"/v1/users/{uuid}": {
"get": {
"tags": [
"Users"
],
"summary": "Get user profile by UUID",
"description": "Get the profile of a user by their UUID. Accessible anonymously: the owner or an admin receives the full profile, everyone else (including anonymous callers) receives the public view.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserGetResponsePublic"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
}
]
},
"patch": {
"tags": [
"Users"
],
"summary": "Update user profile by UUID",
"description": "Update the profile of a user by their UUID. If the UUID matches the currently authenticated user, it will update their own profile. Otherwise, it requires admin permissions to update another user's profile.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserPatchRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{uuid}/permissions": {
"get": {
"tags": [
"Users"
],
"summary": "Get user permissions by UUID",
"description": "Get the permissions of a user by their UUID. Users can view their own permissions, or admins can view any user's permissions.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{uuid}/avatar": {
"patch": {
"tags": [
"Users"
],
"summary": "Update user avatar by UUID",
"description": "Update the avatar of a user by their UUID. If the UUID matches the currently authenticated user, it will update their own avatar. Otherwise, it requires admin permissions to update another user's avatar.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"avatar"
],
"type": "object",
"properties": {
"avatar": {
"$ref": "#/components/schemas/IFormFile"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMediaAvatarPatchResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{uuid}/banner": {
"patch": {
"tags": [
"Users"
],
"summary": "Update user banner by UUID",
"description": "Update the banner of a user by their UUID. If the UUID matches the currently authenticated user, it will update their own banner. Otherwise, it requires admin permissions to update another user's banner.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"banner"
],
"type": "object",
"properties": {
"banner": {
"$ref": "#/components/schemas/IFormFile"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserMediaBannerPatchResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"429": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TooManyRequests"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{uuid}/sessions": {
"get": {
"tags": [
"Users"
],
"summary": "Get user sessions by UUID",
"description": "Get the sessions of a user by their UUID. If the UUID matches the currently authenticated user, it will return their own sessions. Otherwise, it requires permission to read sessions, either globally or delegated for that specific user.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "onlyActive",
"in": "query",
"schema": {
"type": "boolean",
"default": true
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserSessionResponse"
}
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{uuid}/sessions/{sessionId}": {
"delete": {
"tags": [
"Users"
],
"summary": "Delete user sessions by UUID",
"description": "Delete the sessions of a user by their UUID. If the UUID matches the currently authenticated user, it will allow them to delete their own sessions. Otherwise, it requires permission to delete sessions, either globally or delegated for that specific user.",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "sessionId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"204": {
"description": "No Content"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"500": {
"description": "Internal Server Error",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InternalServerError"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/departments": {
"get": {
"tags": [
"Departments"
],
"summary": "Get Departments",
"description": "Retrieves the adepartments visible listto ofthe departmentscaller. Use ?tree=true for hierarchical view.",
"parameters": [
{
"name": "tree",
"in": "query",
"schema": {
"type": "boolean",
"default": false
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DepartmentResponse"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
},
"post": {
"tags": [
"Departments"
],
"summary": "Create Department",
"description": "Creates a new department with system roles",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentCreateRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentResponse"
}
}
}
},
"401422": {
"description": "UnauthorizedUnprocessable Entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedErrorResponse"
}
}
}
},
"403400": {
"description": "ForbiddenBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenBadRequest"
}
}
}
},
},
"security"401": [{
{ "description": "Unauthorized",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [ ]{
}
]
}
},
"/v1/departments/{departmentId}": {"$ref": "#/components/schemas/Unauthorized"
"get": {
"tags": [}
"Departments"
}
],
"summary": "Get Department",}
"description": "Retrieves a},
specific department by ID",
"parameters403": [
{
"namedescription": "departmentIdForbidden",
"incontent": "path",{
"requiredapplication/json": true,
{
"schema": {
"type$ref": "string",
#/components/schemas/Forbidden"
"format": "uuid"
}
}
},
{}
},
"namesecurity": "includeMembers",[
{
"in": "query",
"schemaBearer": [ {]
},
"type": "boolean",
{
"defaultApi Token": false[ ]
}
},]
}
{},
"/v1/departments/{departmentId}": {
"nameget": "includeRoles",{
"intags": "query",
[
"schemaDepartments": {
],
"typesummary": "booleanGet Department",
"default"description": false
"Retrieves a specific department by ID, as far as the caller may }
}
]see it",
"responsesparameters": {[
"200": {
"descriptionname": "OKdepartmentId",
"contentin": {"path",
"application/jsonrequired": {
true,
"schema": {
"$reftype": "#/components/schemas/DepartmentResponse"string",
}
"format": "uuid"
}
},
},{
"401name": {"includeMembers",
"descriptionin": "Unauthorizedquery",
"contentschema": {
"application/jsontype": {"boolean",
"schemadefault": {false
}
"$ref": "#/components/schemas/Unauthorized"
},
{
}
"name": "includeRoles",
"in": "query",
"schema": {
"type": "boolean",
}"default": false
}
}
],
"responses": {
"403 "200": {
"description": "ForbiddenOK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenDepartmentResponse"
}
}
}
},
},
"404": {
"securitydescription": [
"Not Found",
"content": {
"Bearerapplication/json": [ ]
{
},
"schema": {
{
"Api Token": [ ]
$ref": "#/components/schemas/NotFound"
}
]
},
"patch": {
}
"tags": [ },
"Departments401": {
],
"summarydescription": "Update DepartmentUnauthorized",
"descriptioncontent": {
"Updates a department's properties",
"parametersapplication/json": [{
{
"schema": {
"name": "departmentId",
"in$ref": "path",#/components/schemas/Unauthorized"
"required": true,
"schema": {}
"type": "string",}
"format": "uuid"}
},
}
"403": {
],
"requestBodydescription": {
"Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentUpdateRequestForbidden"
}
}
},
"required": true}
},
"responsessecurity": {[
"200": {
"descriptionBearer": "OK", [ ]
},
"content": {
"Api Token"application/json": [ {]
}
"schema": {]
},
"patch": {
"$reftags": "#/components/schemas/DepartmentResponse"[
"Departments"
}
],
"summary": "Update }Department",
"description": "Updates a }department's properties",
},"parameters": [
"401": {
"descriptionname": "UnauthorizeddepartmentId",
"contentin": {
"path",
"application/jsonrequired": {
true,
"schema": {
"$ref""type": "#/components/schemas/Unauthorized"string",
}"format": "uuid"
}
}
}],
"403requestBody": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenDepartmentUpdateRequest"
}
}
},
}"required": true
},
"securityresponses": [{
"200": {
"Bearerdescription": [ ]"OK",
},
"content": {
{
"application/json": {
"Api Token": [ ]
"schema": }{
]
},
"delete$ref": {"#/components/schemas/DepartmentResponse"
"tags": [
}
"Departments"
],
}
"summary": "Delete Department",
}
"description": "Deletes a department (must have no children)"},
"parameters204": [{
{
"description": "No Content"
"name": "departmentId" },
"in422": "path",{
"requireddescription": true"Unprocessable Entity",
"schemacontent": {
"typeapplication/json": "string",{
"formatschema": "uuid"{
}
}
"$ref": "#/components/schemas/ErrorResponse"
}
],
}
}
"responses": { },
"200400": {
"description": "OKBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OkBadRequest"
}
}
}
},
"401404": {
"description": "UnauthorizedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedNotFound"
}
}
}
},
"403401": {
"description": "ForbiddenUnauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenUnauthorized"
}
}
}
},
},
"security403": [{
{"description": "Forbidden",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [{
]
}
]
"$ref": "#/components/schemas/Forbidden"
}
},
"/v1/departments/{departmentId}/avatar": {
"patch": {
}
"tags": [
"Departments"}
],
}
"summary": "Update Department Avatar"},
"parameterssecurity": [
{
"nameBearer": "departmentId",[ ]
"in": "path"},
"required": true,{
"schemaApi Token": {[ ]
}
"type": "string",
]
},
"formatdelete": "uuid"{
}"tags": [
}"Departments"
],
"requestBodysummary": { "Delete Department",
"contentdescription": {
"Deletes a department (must have no children)",
"multipart/form-data "parameters": {[
{
"schema "name": {
"departmentId",
"in": "path",
"required": [
"required": true,
"fileschema": {
]"type": "string",
"typeformat": "objectuuid",
}
"properties": {
}
],
"fileresponses": {
"200": {
"$refdescription": "#/components/schemas/IFormFile"
OK",
"content": {
} "application/json": {
}"schema": {
}
"$ref": "#/components/schemas/Ok"
}
},
"required": true }
},
"responses": { },
"200400": {
"description": "OKBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentResponseBadRequest"
}
}
}
},
"401404": {
"description": "UnauthorizedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedNotFound"
}
}
}
},
"403401": {
"description": "ForbiddenUnauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenUnauthorized"
}
}
}
},
},
"403": {
"securitydescription": ["Forbidden",
{
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/departments/{departmentId}/banneravatar": {
"patch": {
"tags": [
"Departments"
],
"summary": "Update Department BannerAvatar",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"type": "object",
"properties": {
"file": {
"$ref": "#/components/schemas/IFormFile"
}
}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentResponse"
}
}
}
},
"204": {
"description": "No Content"
},
"401400": {
"description": "UnauthorizedBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedBadRequest"
}
}
}
},
"403404": {
"description": "ForbiddenNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenNotFound"
}
}
}
},
},
"429": {
"security": [
"description": "Too Many {Requests",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [ ]{
}
]
"$ref": "#/components/schemas/TooManyRequests"
}
},
"/v1/departments/{departmentId}/permissions": {
"get": {
}
"tags": [
"Departments"}
] },
"summary499": {
"Get Department Permissions",
"parametersdescription": [ "Client Closed Request"
{},
"name500": "departmentId",{
"indescription": "pathInternal Server Error",
"requiredcontent": true,{
"schemaapplication/json": {
"typeschema": "string",{
"format$ref": "uuid#/components/schemas/InternalServerError"
}
}
],}
"responses": { },
"200401": {
"description": "OKUnauthorized",
"content": {
"application/json": {
"schema": {
"type$ref": "array",#/components/schemas/Unauthorized"
"items": {}
}
"type": "string"
}
},
"403": {
}
"description": "Forbidden",
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedForbidden"
}
}
}
},
},
"403security": {[
"description": "Forbidden",{
"contentBearer": {[ ]
},
"application/json": {
{
"schemaApi Token": [ {]
}
"$ref": "#/components/schemas/Forbidden"]
}
},
}"/v1/departments/{departmentId}/banner": {
"patch": {
}
"tags": [
}"Departments"
],
}
"summary": "Update Department }Banner",
"securityparameters": [
{
"Bearername": [ ]
"departmentId",
}"in": "path",
{ "required": true,
"Api Tokenschema": [ ]{
}
"type": "string",
]
},
"putformat": {"uuid"
"tags": [ }
"Departments"}
],
"summaryrequestBody": "Set{
Department Permissions",
"parameterscontent": [
{
"namemultipart/form-data": "departmentId",
{
"inschema": "path",
{
"required": true,
[
"schemafile":
{
"type": "string" ],
"formattype": "uuidobject",
}
"properties": {
}
],
"requestBodyfile": {
"content": {
"$ref": "application/json": {
#/components/schemas/IFormFile"
"schema": {}
"$ref": "#/components/schemas/DepartmentPermissionsRequest"}
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentResponse"
}
}
}
},
"204": {
"description": "No Content"
},
"401400": {
"description": "UnauthorizedBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedBadRequest"
}
}
}
},
"403404": {
"description": "ForbiddenNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenNotFound"
}
}
}
},
},
"429": {
"security": [
"description": "Too Many {Requests",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [{
]
}
]"$ref": "#/components/schemas/TooManyRequests"
}
},
"/v1/departments/{departmentId}/members": {
}
"get": {
}
"tags": [
}
"Department Members"
]},
"summary499": "Get Department Members",
{
"parametersdescription": ["Client Closed Request"
{},
"name500": "departmentId",{
"indescription": "pathInternal Server Error",
"requiredcontent": true,{
"schemaapplication/json": {
"typeschema": "string",{
"format$ref": "uuid#/components/schemas/InternalServerError"
}
}
],
}
"responses": {
"200": {}
"description": "OK"},
"content401": {
"application/jsondescription": {"Unauthorized",
"schemacontent": {
"type"application/json": "array",{
"itemsschema": {
"$ref": "#/components/schemas/DepartmentMemberResponseUnauthorized"
}
}
}
}
},
"401403": {
"description": "UnauthorizedForbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedForbidden"
}
}
}
},
"403": {},
"description": "Forbidden",
"security": [
"content": {
"application/jsonBearer": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
[ ]
}
},
"security": [
{
"BearerApi Token": [ ]
},
{
"Api Token": [ ]
}
]},
},"/v1/departments/{departmentId}/permissions": {
"postget": {
"tags": [
"Department MembersDepartments"
],
"summary": "AddGet Department MemberPermissions",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBodyresponses": {
"content200": {
"application/jsondescription": {"OK",
"schemacontent": {
"$refapplication/json": "#/components/schemas/DepartmentMemberAddRequest"{
}
"schema": {
}
}"type": "array",
"required "items": true{
},
"responses": {type": "string"
}
}
}
}
},
"201404": {
"description": "CreatedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentMemberResponseNotFound"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/departments/{departmentId}/members/{userId}": {
"patchput": {
"tags": [
"Department MembersDepartments"
],
"summary": "UpdateSet MemberDepartment RolePermissions",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{],
"namerequestBody": "userId",
{
"incontent": "path",{
"requiredapplication/json": true,{
"schema": {
"type$ref": "string",#/components/schemas/DepartmentPermissionsRequest"
"format": "uuid"}
}
},
] "required": true
},
"requestBodyresponses": {
"content200": {
"application/jsondescription": {
"OK",
"schemacontent": {
"$refapplication/json": "# {
"schema": {
"$ref": "#/components/schemas/DepartmentMemberUpdateRequest"DepartmentResponse"
}
}
}
},
"required204": true{
}, "description": "No Content"
"responses": { },
"200422": {
"description": "OKUnprocessable Entity",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentMemberResponseErrorResponse"
}
}
}
},
"401404": {
"description": "UnauthorizedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedNotFound"
}
}
}
},
"403401": {
"description": "ForbiddenUnauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenUnauthorized"
}
}
}
},
},
"403": {
"securitydescription": ["Forbidden",
"content": {
"Bearerapplication/json": [ ]{
},
"schema": {
"Api Token": [ ]
}
"$ref": "#/components/schemas/Forbidden"
]
},
"delete": {
"tags": [}
"Department Members"}
],
}
"summary": "Remove Department Member"},
"parameterssecurity": [
{
"nameBearer": "departmentId",[ ]
"in": "path"},
"required": true,{
"schemaApi Token": { [ ]
}
]
}
},
"type/v1/departments/{departmentId}/members": "string",{
"get": {
"formattags": [
"uuidDepartment Members"
],
"summary": "Get Department }Members",
},"parameters": [
{
"name": "userIddepartmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OkDepartmentMemberResponse"
}
}
}
}
},
"401404": {
"description": "UnauthorizedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedNotFound"
}
}
}
},
"403401": {
"description": "ForbiddenUnauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenUnauthorized"
}
}
}
},
},
"security403": [{
{ "description": "Forbidden",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [ ]{
}
]"$ref": "#/components/schemas/Forbidden"
}
}
}
}
}
},
"/v1/departments/{departmentId}/roles": {"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
},
"getpost": {
"tags": [
"Department RolesMembers"
],
"summary": "GetAdd Department RolesMember",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responsesrequestBody": {
"200content": {
"descriptionapplication/json": "OK",{
"contentschema": {
"application/json$ref": {
"#/components/schemas/DepartmentMemberAddRequest"
}
"schema": { }
},
"typerequired": "array",true
},
"itemsresponses": {
"201": {
"$ref": "#/components/schemas/DepartmentRoleResponse"
"description": "Created",
"content": {
"application/json": {
"schema": {
}"$ref": "#/components/schemas/DepartmentMemberResponse"
}
}
}
},
"401400": {
"description": "UnauthorizedBad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedBadRequest"
}
}
}
},
"403404": {
"description": "ForbiddenNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenNotFound"
}
}
}
},
},
"security409": [
{
"Bearerdescription": [ ]"Conflict",
},
"content": {
{
"Api Token"application/json": [ ]{
}
]"schema": {
},
"post": {
"tags$ref": ["#/components/schemas/ErrorResponse"
"Department Roles"
}
],
"summary": "Create Custom Role",}
"parameters": [ }
{},
"name401": "departmentId",{
"indescription": "pathUnauthorized",
"requiredcontent": true,{
"schemaapplication/json": {
"typeschema": "string",{
"format "$ref": "uuid#/components/schemas/Unauthorized"
}
}
] }
},
"requestBody403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentRoleCreateRequestForbidden"
}
}
},
"required": true}
},
"responsessecurity": {[
"201": {
"descriptionBearer": "Created",[ ]
},
"content": {
{
"application/json": {
"Api Token": [ ]
"schema": {}
]
}
},
"$ref": "#/components/schemas/DepartmentRoleResponse"/v1/departments/{departmentId}/members/{userId}": {
"patch": {
"tags": }[
"Department Members"
}],
"summary": "Update Member }Role",
},"parameters": [
"401": {
"descriptionname": "UnauthorizeddepartmentId",
"contentin": {"path",
"application/jsonrequired": {true,
"schema": {
"$reftype": "#/components/schemas/Unauthorized"string",
}"format": "uuid"
}
},
},{
"403name": {"userId",
"descriptionin": "Forbiddenpath",
"contentrequired": {true,
"application/jsonschema": {
"schematype": {
"string",
"$refformat": "#/components/schemas/Forbiddenuuid"
}
}
}
}],
"requestBody": {
}
}
"content": {
},
"security"application/json": [{
{
"schema": {
"Bearer": [ ]
},
"$ref": "#/components/schemas/DepartmentMemberUpdateRequest"
{
}
"Api Token": [ ]}
},
]
"required": true
}
},
"/v1/departments/{departmentId}/roles/{roleId}": {
"patchresponses": {
"tags200": [{
"Department Roles"
description": "OK",
],
"content": {
"summary": "Update Role",
"parametersapplication/json": [{
{
"schema": {
"name": "departmentId",
"in$ref": "path",
#/components/schemas/DepartmentMemberResponse"
"required": true,
}
"schema": {}
}
"type": "string",
"format": "uuid"
}
},
{
"name"400": "roleId",{
"indescription": "path",
"required": trueBad Request",
"schemacontent": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody"application/json": {
"content": {
"application/json"schema": {
"schema": {
"$ref": "#/components/schemas/DepartmentRoleUpdateRequestBadRequest"
}
}
},
"required": true
},
"responses": { },
"200404": {
"description": "OKNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentRoleResponseNotFound"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
},
"delete": {
"tags": [
"Department RolesMembers"
],
"summary": "DeleteRemove Department RoleMember",
"descriptionparameters": "Deletes a custom role (system roles cannot be deleted)",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "roleIduserId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ok"
}
}
}
},
"401404": {
"description": "UnauthorizedNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnauthorizedNotFound"
}
}
}
},
"403401": {
"description": "ForbiddenUnauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenUnauthorized"
}
}
}
},
},
"security403": [{
{ "description": "Forbidden",
"Bearercontent": [ ]{
},
"application/json": {
{
"Api Tokenschema": [ ]{
}
]
}
},
"/v1/users/{userId}/departments": {"$ref": "#/components/schemas/Forbidden"
"get": {
"tags": [}
"Users"
}
],
"summary": "Get User Departments",
}
"description": "Retrieves all departments and roles for a specific user"}
},
"parameterssecurity": [
{
"nameBearer": "userId",[ ]
"in": "path"},
"required": true,{
"schemaApi Token": {[ ]
}
"type": "string",
]
}
"format": "uuid"},
"/v1/departments/{departmentId}/roles": {
"get": {
} "tags": [
}"Department Roles"
],
"responsessummary": {
"Get Department Roles",
"200parameters": [
{
"descriptionname": "OKdepartmentId",
"contentin": {
"path",
"application/jsonrequired": {true,
"schema": {
"type": "arraystring",
"itemsformat": {"uuid"
}
"$ref": "#/components/schemas/UserDepartmentResponse" }
],
}"responses": {
}"200": {
}"description": "OK",
}
"content": {
},
"401application/json": {
"description": "Unauthorized",
"content"schema": {
"application/jsontype": {
"array",
"schemaitems": {
"$ref": "#/components/schemas/Unauthorized"DepartmentRoleResponse"
}
}
}
}
},
"403404": {
"description": "ForbiddenNot Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ForbiddenNotFound"
}
}
}
},
},
"security401": [{
{
"description": "Unauthorized",
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]"content": {
}
},
"/.well-known/openid-configurationapplication/json": {
"get": {
"tagsschema": [{
"Discovery"
],
"summary"$ref": "OpenID Provider Metadata",
#/components/schemas/Unauthorized"
"description": "Describes the issuer and the keys that}
verify the tokens this service issues.\nDeliberately partial: no authorization or token endpoint is advertised,}
because the login flow is not an RFC 6749 authorization code flow.",}
"responses": { },
"200403": {
"description": "OKForbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenIdConfigurationResponseForbidden"
}
}
}
}
},
"security": [ ]
}
},{
"/.well-known/jwks.json": {
"getBearer": {[ ]
"tags": [ },
"Discovery"{
],
"Api Token": [ ]
"summary": "JSON Web Key Set",
}
"description": "Returns the public key ]
used to verify JWT signatures},
as an OKP JWK Set (RFC 8037).\nThe key's 'kid' matches the 'kid' header of the tokens signed with it. Never cache the response: the key is replaced to revoke every issued token at once.""post": {
"tags": [
"Department Roles"
],
"responsessummary": {
"Create Custom Role",
"200parameters": [
{
"descriptionname": "OKdepartmentId",
"contentin": {"path",
"application/jsonrequired": {
true,
"schema": {
"$reftype": "#/components/schemas/JsonWebKeySetResponse"string",
}"format": "uuid"
}
}
}],
"503requestBody": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetailsDepartmentRoleCreateRequest"
}
}
},
}"required": true
},
"securityresponses": [ ]{
}
},
"/"201": {
"get": {
"tagsdescription": [
"Created",
"Cyberzone.Julia"
content": {
],
"responsesapplication/json": {
"200": { "schema": {
"$ref": "#/components/schemas/DepartmentRoleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/departments/{departmentId}/roles/{roleId}": {
"patch": {
"tags": [
"Department Roles"
],
"summary": "Update Role",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "roleId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentRoleUpdateRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DepartmentRoleResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
},
"delete": {
"tags": [
"Department Roles"
],
"summary": "Delete Role",
"description": "Deletes a custom role (system roles cannot be deleted)",
"parameters": [
{
"name": "departmentId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
},
{
"name": "roleId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Ok"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotFound"
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/v1/users/{userId}/departments": {
"get": {
"tags": [
"Users"
],
"summary": "Get User Departments",
"description": "Retrieves the departments and roles of a user: all of one's own, and for anyone else the memberships the caller may see",
"parameters": [
{
"name": "userId",
"in": "path",
"required": true,
"schema": {
"type": "string",
"format": "uuid"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDepartmentResponse"
}
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
}
},
"security": [
{
"Bearer": [ ]
},
{
"Api Token": [ ]
}
]
}
},
"/.well-known/openid-configuration": {
"get": {
"tags": [
"Discovery"
],
"summary": "OpenID Provider Metadata",
"description": "Describes the issuer and the keys that verify the tokens this service issues.\nDeliberately partial: no authorization or token endpoint is advertised, because the login flow is not an RFC 6749 authorization code flow.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OpenIdConfigurationResponse"
}
}
}
}
},
"security": [ ]
}
},
"/.well-known/jwks.json": {
"get": {
"tags": [
"Discovery"
],
"summary": "JSON Web Key Set",
"description": "Returns the public key used to verify JWT signatures, as an OKP JWK Set (RFC 8037).\nThe key's 'kid' matches the 'kid' header of the tokens signed with it. Never cache the response: the key is replaced to revoke every issued token at once.",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/JsonWebKeySetResponse"
}
}
}
},
"503": {
"description": "Service Unavailable",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
},
"security": [ ]
}
},
"/": {
"get": {
"tags": [
"Cyberzone.Julia"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/health": {
"get": {
"tags": [
"Cyberzone.Julia"
],
"responses": {
"200": {
"description": "OK"
}
},
"security": [ ]
}
}
},
"components": {
"schemas": {
"AuthentikEventType": {
"enum": [
"UserCreated",
"UserUpdated",
"UserDeleted",
"GroupCreated",
"GroupUpdated",
"GroupDeleted"
]
},
"AuthentikWebhook": {
"required": [
"event_type",
"data"
],
"type": "object",
"properties": {
"event_type": {
"$ref": "#/components/schemas/AuthentikEventType"
},
"initiator_username": {
"type": [
"null",
"string"
]
},
"data": {
"$ref": "#/components/schemas/JsonElement"
}
}
},
"BadRequest": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"ClientApplicationCreateRequest": {
"required": [
"name",
"clientApplicationCallbackUrl"
],
"type": "object",
"properties": {
"name": {
"maxLength": 128,
"type": "string"
},
"clientApplicationCallbackUrl": {
"type": "string",
"descriptionformat": "OKuri"
},
"isActive": {
"type": "boolean"
}
}
},
"/healthClientApplicationResponse": {
"getrequired": {
[
"id",
"tags": [name",
"clientApplicationCallbackUrl",
"Cyberzone.JuliaisActive"
],
"responsestype": "object",
"properties": {
"200id": {
"descriptiontype": "OKstring",
}
"format": "uuid"
},
"securityname": [ ]
{
}"type": "string"
}
},
"components "clientApplicationCallbackUrl": {
"schemas "type": {
"string",
"AuthentikEventTypeformat": {
"uri"
},
"enumisActive": [{
"UserCreated","type": "boolean"
"UserUpdated",
}
}
"UserDeleted"},
"DepartmentCreateRequest": {
"GroupCreatedrequired",: [
"GroupUpdatedslug",
"GroupDeletedname"
],
}"type": "object",
"AuthentikWebhookproperties": {
"requiredslug": [{
"event_type"maxLength": 64,
"dataminLength": 2,
"pattern": "^[a-z0-9]+(-[a-z0-9]+)*$",
"type": "object"string"
},
"propertiesname": {
"event_typemaxLength": {256,
"$reftype": "#/components/schemas/AuthentikEventTypestring"
},
"initiator_usernamedescription": {
"type": [
"null",
"string"
]
},
"dataparent_id": {
"$reftype": "#/components/schemas/JsonElement"[
}
}
}"null",
"BadRequest": {
"type": "object",string"
"properties": {
"error": {],
"typeformat": "stringuuid"
},
"messagepermissions": {
"type": [
"null",
"stringarray"
],
}
"items": {
}
},
"ClientApplicationCreateRequesttype": {"string"
"required": [ }
"name"},
"clientApplicationCallbackUrl"
inherit_permissions": {
],
"type": "objectboolean",
"properties": { },
"namesort_order": {
"maxLengthpattern": 128"^-?(?:0|[1-9]\\d*)$",
"type": "string"
[
}"integer",
"clientApplicationCallbackUrlstring": {
"type": "string"],
"format": "uriint32"
},
"isActiveis_hidden": {
"type": "boolean"
}
}
},
"ClientApplicationResponseDepartmentMemberAddRequest": {
"required": [
"user_id",
"name",
"clientApplicationCallbackUrl",
"isActiverole_slug"
],
"type": "object",
"properties": {
"user_id": {
"type": "string",
"format": "uuid"
},
"namerole_slug": {
"typemaxLength": "string"
},
"clientApplicationCallbackUrl": {128,
"type": "string",
}
"format": "uri"
}
},
"isActiveDepartmentMemberResponse": {
"typerequired": "boolean"[
}
}
},
"DepartmentCreateRequest": {
"id",
"required": [department_id",
"sluguser_id",
"namerole"
],
"type": "object",
"properties": {
"slugid": {
"maxLengthtype": 128"string",
"typeformat": "stringuuid"
},
"namedepartment_id": {
"maxLengthtype": 256"string",
"typeformat": "stringuuid"
},
"descriptionuser_id": {
"type": ["string",
"format": "nulluuid",
},
"stringrole": {
]"$ref": "#/components/schemas/DepartmentRoleResponse"
},
"parentis_idpublic": {
"type": ["boolean"
"null"},
"string""joined_at": {
]"type": "string",
"format": "uuiddate-time"
},
"permissions": {}
},
"typeDepartmentMemberUpdateRequest": [{
"null"type": "object",
"array""properties": {
],"role_slug": {
"itemsmaxLength": {128,
"type": "string"[
}
"null",
},
"inherit_permissions": {string"
"type": "boolean"]
},
"sortis_orderpublic": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integernull",
"stringboolean"
],
"format": "int32"
}
}
},
"DepartmentMemberAddRequestDepartmentPermissionsRequest": {
"required": [
"user_idpermissions",
"role_slug"
],
"type": "object",
"properties": {
"user_idpermissions": {
"type": "string",
"formattype": "uuidarray",
},
"role_slugitems": {
"maxLengthtype": 128,"string"
"type": "string"}
}
}
},
"DepartmentMemberResponseDepartmentResponse": {
"required": [
"id",
"department_idslug",
"user_idname",
"role"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"department_idslug": {
"type": "string"
},
"name": {
"formattype": "uuidstring"
},
"user_iddescription": {
"type": "string",[
"format": "uuidnull",
},
"rolestring": {
"$ref": "#/components/schemas/DepartmentRoleResponse"]
},
"joinedavatar_aturl": {
"type": "string",[
"format": "date-timenull",
}
"string"
}
]
},
"DepartmentMemberUpdateRequest "banner_url": {
"requiredtype": [
"role_slugnull",
],
"string"
"type": "object",
]
"properties": { },
"roleparent_slugid": {
"maxLengthtype": 128,[
"type": "stringnull",
}
"string"
}],
},
"DepartmentPermissionsRequestformat": {"uuid"
"required": [ },
"permissions": {
],
"type": "object",[
"properties": {
"null",
"permissionsarray": {
"type": "array"],
"items": {
"type": "string"
}
},
}"inherit_permissions": {
},
"DepartmentResponsetype": {[
"required": [
"idnull",
"slug",
"boolean"
"name"
],
"type": "object" },
"propertiessort_order": {
"idpattern": {"^-?(?:0|[1-9]\\d*)$",
"type": "string",[
"format": "uuidinteger",
}, "string"
"slug": { ],
"typeformat": "stringint32"
},
"nameis_hidden": {
"type": "stringboolean"
},
"descriptionis_active": {
"type": ["boolean"
},
"null", "created_at": {
"type": "string",
]"format": "date-time"
},
"avatarupdated_urlat": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"banner_urlchildren": {
"type": [
"null",
"stringarray"
],
},
"parent_id"items": {
"type$ref": ["#/components/schemas/DepartmentResponse"
"null",}
"string"},
],"members": {
"formattype": "uuid"
[
}"null",
"permissionsarray": {
"type": "array"],
"items": {
"type$ref": "string#/components/schemas/DepartmentMemberResponse"
}
},
"inherit_permissionsroles": {
"type": "boolean"[
} "null",
"sort_order": {
array"
"pattern": "^-?(?:0|[1-9]\\d*)$",
"typeitems": [{
"integer",$ref": "#/components/schemas/DepartmentRoleResponse"
}
"string"
}
}
] },
"DepartmentRoleCreateRequest": {
"formatrequired": "int32"[
}"name",
"is_active": {
slug"
],
"type": "booleanobject",
},"properties": {
"created_atname": {
"typemaxLength": "string"128,
"formattype": "date-timestring"
},
"updated_at": {
"typeslug": [{
"nullmaxLength": 128,
"type": "string"
]},
"formatweight": "date-time"
{
}"maximum": 999,
"childrenminimum": {3,
"typepattern": "^-?(?:0|[1-9]\\d*)$",
"nulltype",: [
"arrayinteger",
],"string"
"items": {
],
"$refformat": "#/components/schemas/DepartmentResponseint32"
}
},
"memberspermissions": {
"type": [
"null",
"array"
],
"items": {
"$reftype": "#/components/schemas/DepartmentMemberResponsestring"
}
},
}
},
"rolesDepartmentRoleResponse": {
"typerequired": [
"nullid",
"arraydepartment_id",
]"name",
"itemsslug":
{
],
"$reftype": "#/components/schemas/DepartmentRoleResponse"object",
"properties": {
}
}"id": {
}
}"type": "string",
"DepartmentRoleCreateRequest": {
"requiredformat": ["uuid"
"name"},
"slug"
department_id": {
],
"type": "objectstring",
"propertiesformat": {"uuid"
"name": {
},
"maxLengthname": 128,{
"type": "string"
},
"slug": {
"maxLength": 128,
"type": "string"
},
"weightis_system": {
"maximumtype": 999,
"boolean"
},
"minimumweight": 3,{
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"integer",
"string"
],
"format": "int32"
},
"permissions": {
"type": [
"null",
"array"
],
"items": {
"type": "string"
}
}
}
},
"DepartmentRoleResponse": {
"required": [
"id",
"department_id",
"name",
"slug"
],
"type": "object",
"properties": {
"id""created_at": {
"type": "string",
"format": "uuiddate-time"
},
"departmentupdated_idat": {
"type": "string",[
"format": "uuid"
},
"name": {
null",
"type": "string"
} ],
"slugformat": {"date-time"
}
"type": "string"
}
},
"is_system"DepartmentRoleUpdateRequest": {
"type": "booleanobject",
},"properties": {
"weightname": {
"patternmaxLength": "^-?(?:0|[1-9]\\d*)$"128,
"type": [
"integernull",
"string"
],
},
"format": "int32"
"slug": {
},
"permissionsmaxLength": {128,
"type": "array",[
"itemsnull": {,
"type": "string"
}]
},
"created_atweight": {
"typemaximum": "string"999,
"formatminimum": "date-time"
3,
},
"updated_at": {"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"stringinteger"
,
],
"format": "date-time"
string"
}
}
}],
"DepartmentRoleUpdateRequest": {
"typeformat": "objectint32",
"properties": {
"name": {
},
"maxLengthpermissions": 128,{
"type": [
"null",
"stringarray"
],
},
"slugitems": {
"maxLength": 128,
"type": ["string"
"null",}
"string"}
]
}
},
"weightDepartmentUpdateRequest": {
"maximumtype": 999"object",
"minimumproperties": 3,{
"patternslug": "^-?(?:0|[1-9]\\d*)$",{
"type": [
"null",
"integerstring",
"string"]
]},
"formatname": "int32"
{
},
"permissionsmaxLength": {256,
"type": [
"null",
"arraystring"
],
"items": {},
"typedescription": "string"{
}
}"type": [
}
}"null",
"DepartmentUpdateRequest": {
"type": "object",string"
"properties": {
]
"slug": {
},
"maxLengthparent_id": 128,{
"type": [
"null",
"string"
],
},
"format": "uuid"
"name": {
},
"maxLengthinherit_permissions": 256,{
"type": [
"null",
"stringboolean"
]
},
"descriptionsort_order": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"stringinteger",
]"string"
}],
"parent_idformat": {"int32"
},
"typeis_active": [{
"nulltype",: [
"stringnull",
], "boolean"
"format": "uuid"]
},
"inheritis_permissionshidden": {
"type": [
"null",
"boolean"
]
},
"sort_order": {}
},
"patternErrorResponse": "^-?(?:0|[1-9]\\d*)$",
{
"typerequired": [
"error"
"null",
],
"type": "integerobject",
"stringproperties": {
],"error": {
"formattype": "int32string"
},
"is_activemessage": {
"type": [
"null",
"booleanstring"
]
}
}
},
"ExchangeRequest": {
"type": "object",
"properties": {
"code": {
"type": "string"
}
}
},
"Forbidden": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"IFormFile": {
"type": "string",
"format": "binary"
},
"InternalServerError": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"JsonElement": { },
"JsonWebKeyResponse": {
"required": [
"kty",
"crv",
"x",
"alg",
"use",
"kid"
],
"type": "object",
"properties": {
"kty": {
"type": "string"
},
"crv": {
"type": "string"
},
"x": {
"type": "string"
},
"alg": {
"type": "string"
},
"use": {
"type": "string"
},
"kid": {
"type": "string"
}
}
},
"JsonWebKeySetResponse": {
"required": [
"keys"
],
"type": "object",
"properties": {
"keys": {
"type": "array",
"items": {
"$ref": "#/components/schemas/JsonWebKeyResponse"
}
}
}
},
"LoginResponse": {
"required": [
"access_token",
"refresh_token"
],
"type": "object",
"properties": {
"access_token": {
"type": "string"
},
"refresh_token": {
"type": "string"
},
"expires_in": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"format": "int32"
}
}
},
"LogoutRequest": {
"type": "object",
"properties": {
"sessionId": {
"type": [
"null",
"string"
],
"format": "uuid"
}
}
},
"NotFound": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"Ok": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"message": { }
}
},
"OpenIdConfigurationResponse": {
"required": [
"issuer",
"jwks_uri",
"subject_types_supported",
"id_token_signing_alg_values_supported",
"response_types_supported",
"grant_types_supported",
"claims_supported"
],
"type": "object",
"properties": {
"issuer": {
"type": "string"
},
"jwks_uri": {
"type": "string"
},
"subject_types_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"id_token_signing_alg_values_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"response_types_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"grant_types_supported": {
"type": "array",
"items": {
"type": "string"
}
},
"claims_supported": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": [
"null",
"string"
]
},
"title": {
"type": [
"null",
"string"
]
},
"status": {
"pattern": "^-?(?:0|[1-9]\\d*)$",
"type": [
"null",
"integer",
"string"
],
"format": "int32"
},
"detail": {
"type": [
"null",
"string"
]
},
"instance": {
"type": [
"null",
"string"
]
}
}
},
"RefreshTokenRequest": {
"type": "object",
"properties": {
"refresh_token": {
"type": "string"
}
}
},
"TooManyRequests": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"Unauthorized": {
"type": "object",
"properties": {
"error": {
"type": "string"
},
"message": {
"type": [
"null",
"string"
]
}
}
},
"UserDepartmentResponse": {
"required": [
"department",
"role"
],
"type": "object",
"properties": {
"department": {
"$ref": "#/components/schemas/DepartmentResponse"
},
"role": {
"$ref": "#/components/schemas/DepartmentRoleResponse"
},
"is_public": {
"type": "boolean"
},
"joined_at": {
"type": "string",
"format": "date-time"
}
}
},
"UserGetResponse": {
"required": [
"id",
"email",
"username",
"firstname",
"lastname",
"permissions",
"groups",
"departments"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"email": {
"type": "string"
},
"username": {
"type": "string"
},
"firstname": {
"type": "string"
},
"lastname": {
"type": "string"
},
"middlename": {
"type": [
"null",
"string"
]
},
"avatar": {
"type": [
"null",
"string"
]
},
"banner": {
"type": [
"null",
"string"
]
},
"permissions": {
"type": "array",
"items": {
"type": "string"
}
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroup"
}
},
"departments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserDepartmentResponse"
}
}
}
},
"UserGetResponsePublic": {
"required": [
"id",
"username",
"groups"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"username": {
"type": "string"
},
"avatar": {
"type": [
"null",
"string"
]
},
"banner": {
"type": [
"null",
"string"
]
},
"groups": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserGroup"
}
}
}
},
"UserGroup": {
"required": [
"slug"
],
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"name": {
"type": [
"null",
"string"
]
},
"logo": {
"type": [
"null",
"string"
]
}
}
},
"UserMediaAvatarPatchResponse": {
"required": [
"avatarUrl"
],
"type": "object",
"properties": {
"avatarUrl": {
"type": "string"
}
}
},
"UserMediaBannerPatchResponse": {
"required": [
"bannerUrl"
],
"type": "object",
"properties": {
"bannerUrl": {
"type": "string"
}
}
},
"UserPatchRequest": {
"type": "object",
"properties": {
"username": {
"pattern": "^[a-zA-Z0-9_-]{3,32}$",
"type": [
"null",
"string"
]
},
"email": {
"maxLength": 320,
"minLength": 0,
"type": [
"null",
"string"
]
},
"firstname": {
"maxLength": 128,
"minLength": 1,
"type": [
"null",
"string"
]
},
"lastname": {
"maxLength": 128,
"minLength": 1,
"type": [
"null",
"string"
]
},
"middlename": {
"maxLength": 128,
"minLength": 0,
"type": [
"null",
"string"
]
}
}
},
"UserSessionResponse": {
"required": [
"id",
"createdAt",
"expiresAt",
"ipAddresses",
"userAgent"
],
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid"
},
"createdAt": {
"type": "string",
"format": "date-time"
},
"updatedAt": {
"type": [
"null",
"string"
],
"format": "date-time"
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"ipAddresses": {
"type": "array",
"items": {
"type": "string"
}
},
"userAgent": {
"type": "string"
}
}
}
},
"securitySchemes": {
"Bearer": {
"type": "http",
"description": "JWT Authorization header",
"scheme": "bearer",
"bearerFormat": "Json Web Token"
},
"Api Token": {
"type": "apiKey",
"description": "API Key",
"name": "X-Api-Key",
"in": "header"
}
}
},
"tags": [
{
"name": "Admin"
},
{
"name": "OAuth Authentication"
},
{
"name": "Authentication and Authorization"
},
{
"name": "Webhooks"
},
{
"name": "Users"
},
{
"name": "Departments"
},
{
"name": "Department Members"
},
{
"name": "Department Roles"
},
{
"name": "Discovery"
},
{
"name": "Cyberzone.Julia",
"x-scalar-ignore": true
}
],
"externalDocs": {
"description": "Full documentation",
"url": "https://confluence.cyberzone.dev/spaces/ASDPUB/overview"
}
} |
...