{ "openapi": "3.0.4", "info": { "title": "FoxIDs Control API", "version": "v2" }, "servers": [ { "url": "https://control.foxids.com/api" } ], "paths": { "/@master/!ClientSettings": { "get": { "tags": [ "master clientsettings" ], "summary": "Get client settings.", "operationId": "GetClientSettings", "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ControlClientSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ControlClientSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ControlClientSettings" } } } } } } }, "/@master/!FilterPlan": { "get": { "tags": [ "master filterplan" ], "summary": "Obsolete please use 'Plans' instead.\nFilter plan.", "operationId": "GetFilterPlan", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter plan name.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Plan" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/@master/!Plan": { "get": { "tags": [ "master plan" ], "summary": "Get plan.", "operationId": "GetPlan", "parameters": [ { "name": "name", "in": "query", "description": "Plan name.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "master plan" ], "summary": "Create plan.", "operationId": "PostPlan", "requestBody": { "description": "plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "master plan" ], "summary": "Update plan.", "operationId": "PutPlan", "requestBody": { "description": "Plan.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Plan" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Plan" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Plan" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "master plan" ], "summary": "Delete plan.", "operationId": "DeletePlan", "parameters": [ { "name": "name", "in": "query", "description": "Plan name.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/@master/!Plans": { "get": { "tags": [ "master plans" ], "summary": "Get plans.", "operationId": "GetPlans", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter plan name.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/PlanPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/PlanPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/PlanPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/@master/!RiskPassword": { "get": { "tags": [ "master riskpassword" ], "summary": "Get risk password.", "operationId": "GetRiskPassword", "parameters": [ { "name": "passwordSha1Hash", "in": "query", "description": "Password SHA1 hash.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskPassword" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskPassword" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskPassword" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "master riskpassword" ], "summary": "Update risk passwords.", "operationId": "PutRiskPassword", "requestBody": { "description": "Risk passwords.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RiskPasswordRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" } } }, "delete": { "tags": [ "master riskpassword" ], "summary": "Delete risk passwords.", "operationId": "DeleteRiskPassword", "requestBody": { "description": "Delete specified risk passwords.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordDelete" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordDelete" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/RiskPasswordDelete" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/@master/!RiskPasswordFirst": { "get": { "tags": [ "master riskpasswordfirst" ], "summary": "Get the first 1000 risk password. Can be used query risk passwords before deleting them.", "operationId": "GetRiskPasswordFirst", "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RiskPassword" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RiskPassword" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RiskPassword" } } } } }, "404": { "description": "Not Found" } } } }, "/@master/!RiskPasswordInfo": { "get": { "tags": [ "master riskpasswordinfo" ], "summary": "Get risk password info.", "operationId": "GetRiskPasswordInfo", "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RiskPasswordInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RiskPasswordInfo" } } } }, "404": { "description": "Not Found" } } } }, "/@master/!RiskPasswordTest": { "get": { "tags": [ "master riskpasswordtest" ], "summary": "Test if a password has appeared in breaches and is in risk.", "operationId": "GetRiskPasswordTest", "parameters": [ { "name": "password", "in": "query", "description": "Password.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "boolean" } }, "application/json": { "schema": { "type": "boolean" } }, "text/json": { "schema": { "type": "boolean" } } } }, "404": { "description": "Not Found" } } } }, "/@master/!SmsPrice": { "get": { "tags": [ "master smsprice" ], "summary": "Get SMS price.", "operationId": "GetSmsPrice", "parameters": [ { "name": "iso2", "in": "query", "description": "SMS price ISO2.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "master smsprice" ], "summary": "Create SMS price.", "operationId": "PostSmsPrice", "requestBody": { "description": "SMS price.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "master smsprice" ], "summary": "Update SMS price.", "operationId": "PutSmsPrice", "requestBody": { "description": "SMS price.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPrice" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "master smsprice" ], "summary": "Delete SMS price.", "operationId": "DeleteSmsPrice", "parameters": [ { "name": "iso2", "in": "query", "description": "SMS price ISO2.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/@master/!SmsPrices": { "get": { "tags": [ "master smsprices" ], "summary": "Get SMS prices.", "operationId": "GetSmsPrices", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter SMS price by country name and ISO2.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SmsPricePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SmsPricePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SmsPricePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/@master/!UsageSettings": { "get": { "tags": [ "master usagesettings" ], "summary": "Get usage settings.", "operationId": "GetUsageSettings", "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "master usagesettings" ], "summary": "Update usage settings.", "operationId": "PutUsageSettings", "requestBody": { "description": "Usage settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageSettings" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!AccessStructure": { "get": { "tags": [ "tenant accessstructure" ], "summary": "Get Access structure data document.", "operationId": "GetAccessStructure", "parameters": [ { "name": "id", "in": "query", "description": "Stable access structure ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant accessstructure" ], "summary": "Create Access structure.", "operationId": "PostAccessStructure", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Access structure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant accessstructure" ], "summary": "Update Access structure.", "operationId": "PutAccessStructure", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Access structure.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructure" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant accessstructure" ], "summary": "Delete Access structure.", "operationId": "DeleteAccessStructure", "parameters": [ { "name": "id", "in": "query", "description": "Stable access structure ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!AccessStructureMemberships": { "get": { "tags": [ "tenant accessstructurememberships" ], "summary": "Get Access structure memberships for an internal or external user.", "operationId": "GetAccessStructureMemberships", "parameters": [ { "name": "UserType", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UserTypes" } }, { "name": "UserId", "in": "query", "required": true, "schema": { "maxLength": 40, "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant accessstructurememberships" ], "summary": "Replace Access structure memberships for an internal or external user.", "operationId": "PutAccessStructureMemberships", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Membership update request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsUpdateRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructureMembershipsResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!AccessStructures": { "get": { "tags": [ "tenant accessstructures" ], "summary": "Get Access structure data documents.", "operationId": "GetAccessStructures", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter by data document name.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/AccessStructurePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/AccessStructurePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/AccessStructurePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!ActiveSession": { "get": { "tags": [ "tenant activesession" ], "summary": "Get active session.", "operationId": "GetActiveSession", "parameters": [ { "name": "sessionId", "in": "query", "description": "The session ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActiveSession" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActiveSession" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveSession" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant activesession" ], "summary": "Delete active session.", "operationId": "DeleteActiveSession", "parameters": [ { "name": "sessionId", "in": "query", "description": "The session ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!ActiveSessions": { "get": { "tags": [ "tenant activesessions" ], "summary": "Get active sessions.", "operationId": "GetActiveSessions", "parameters": [ { "name": "filterUserIdentifier", "in": "query", "description": "Filter by the user identifier which can be: email, phone or username.", "schema": { "type": "string" } }, { "name": "filterSub", "in": "query", "description": "Filter by the users SUB claim.", "schema": { "type": "string" } }, { "name": "filterDownPartyName", "in": "query", "description": "Filter by the application.", "schema": { "type": "string" } }, { "name": "filterUpPartyName", "in": "query", "description": "Filter by the authentication method.", "schema": { "type": "string" } }, { "name": "filterSessionId", "in": "query", "description": "Filter by the session ID.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ActiveSessionPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ActiveSessionPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ActiveSessionPaginationResponse" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant activesessions" ], "summary": "Delete active sessions.", "operationId": "DeleteActiveSessions", "parameters": [ { "name": "userIdentifier", "in": "query", "description": "User identifier which can be: email, phone or username.", "schema": { "type": "string" } }, { "name": "sub", "in": "query", "description": "The users SUB claim.", "schema": { "type": "string" } }, { "name": "downPartyName", "in": "query", "description": "Filter by the application.", "schema": { "type": "string" } }, { "name": "upPartyName", "in": "query", "description": "Filter by the authentication method.", "schema": { "type": "string" } }, { "name": "sessionId", "in": "query", "description": "Filter by session ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!DownParties": { "get": { "tags": [ "tenant downparties" ], "summary": "Get application registrations.", "operationId": "GetDownParties", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter application registration name.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownPartyPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownPartyPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownPartyPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!DownPartyTest": { "post": { "tags": [ "tenant downpartytest" ], "summary": "Start new down-party test.", "operationId": "PostDownPartyTest", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Down-party test start request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestStartResponse" } } } } } }, "put": { "tags": [ "tenant downpartytest" ], "summary": "Get the down-party test result.", "operationId": "PutDownPartyTest", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Down-party test result request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/DownPartyTestResultResponse" } } } } } } }, "/{tenant_name}/{track_name}/!ExternalLoginSecretUpParty": { "get": { "tags": [ "tenant externalloginsecretupparty" ], "summary": "Get External login secret for authentication method.", "operationId": "GetExternalLoginSecretUpParty", "parameters": [ { "name": "partyName", "in": "query", "description": "External login authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalLoginSecretResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalLoginSecretResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalLoginSecretResponse" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true }, "put": { "tags": [ "tenant externalloginsecretupparty" ], "summary": "Update External login secret for authentication method.", "operationId": "PutExternalLoginSecretUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "External login secret for authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalLoginSecretRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "409": { "description": "Conflict" } }, "deprecated": true }, "delete": { "tags": [ "tenant externalloginsecretupparty" ], "summary": "Delete External login secret for authentication method.", "operationId": "DeleteExternalLoginSecretUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!ExternalLoginUpParty": { "get": { "tags": [ "tenant externalloginupparty" ], "summary": "Get external login authentication method.", "operationId": "GetExternalLoginUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } } } }, "404": { "description": "Not Found" } }, "deprecated": true }, "post": { "tags": [ "tenant externalloginupparty" ], "summary": "Create external login authentication method.", "operationId": "PostExternalLoginUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "API authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } } } }, "409": { "description": "Conflict" } }, "deprecated": true }, "put": { "tags": [ "tenant externalloginupparty" ], "summary": "Update external login authentication method.", "operationId": "PutExternalLoginUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "API authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalLoginUpParty" } } } }, "404": { "description": "Not Found" } }, "deprecated": true }, "delete": { "tags": [ "tenant externalloginupparty" ], "summary": "Delete external login authentication method.", "operationId": "DeleteExternalLoginUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!ExternalUser": { "get": { "tags": [ "tenant externaluser" ], "summary": "Get external user.", "operationId": "GetExternalUser", "parameters": [ { "name": "UpPartyName", "in": "query", "required": true, "schema": { "maxLength": 50, "type": "string" } }, { "name": "LinkClaimValue", "in": "query", "schema": { "maxLength": 10000, "type": "string" } }, { "name": "RedemptionClaimValue", "in": "query", "schema": { "maxLength": 10000, "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant externaluser" ], "summary": "Create external user.", "operationId": "PostExternalUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ExternalUser.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalUserRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant externaluser" ], "summary": "Update external user.\nAdd a value in the 'UpdateUpPartyName' attribute to change which authentication method (up-party) the external user is connected to.\nAdd a value in the 'LinkClaimValue' and / or 'RedemptionClaimValue' attributes to change the link claim value and / or redemption claim value. The field is set to an empty string if the value is a empty string.", "operationId": "PutExternalUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "External user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUserUpdateRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUserUpdateRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ExternalUserUpdateRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUser" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant externaluser" ], "summary": "Delete external user.", "operationId": "DeleteExternalUser", "parameters": [ { "name": "UpPartyName", "in": "query", "required": true, "schema": { "maxLength": 50, "type": "string" } }, { "name": "LinkClaimValue", "in": "query", "schema": { "maxLength": 10000, "type": "string" } }, { "name": "RedemptionClaimValue", "in": "query", "schema": { "maxLength": 10000, "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!ExternalUsers": { "get": { "tags": [ "tenant externalusers" ], "summary": "Get external users.", "operationId": "GetExternalUsers", "parameters": [ { "name": "filterValue", "in": "query", "description": "Filter external user by link claim, redemption claim, or user ID.", "schema": { "type": "string" } }, { "name": "filterClaimValue", "in": "query", "description": "Filter external user by claim value.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ExternalUserPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ExternalUserPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ExternalUserPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!FailingLoginLock": { "get": { "tags": [ "tenant failingloginlock" ], "summary": "Get failing login lock.", "operationId": "GetFailingLoginLock", "parameters": [ { "name": "userIdentifier", "in": "query", "description": "The user identifier.", "schema": { "type": "string" } }, { "name": "failingLoginType", "in": "query", "description": "The failing login type.", "schema": { "$ref": "#/components/schemas/FailingLoginTypes" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant failingloginlock" ], "summary": "Delete failing login lock.", "operationId": "DeleteFailingLoginLock", "parameters": [ { "name": "userIdentifier", "in": "query", "description": "The user identifier.", "schema": { "type": "string" } }, { "name": "failingLoginType", "in": "query", "description": "The failing login type.", "schema": { "$ref": "#/components/schemas/FailingLoginTypes" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!FailingLoginLocks": { "get": { "tags": [ "tenant failingloginlocks" ], "summary": "Get failing login locks.", "operationId": "GetFailingLoginLocks", "parameters": [ { "name": "filterUserIdentifier", "in": "query", "description": "Filter by the user identifier.", "schema": { "type": "string" } }, { "name": "filterFailingLoginType", "in": "query", "description": "Filter by the failing login type.", "schema": { "$ref": "#/components/schemas/FailingLoginTypes" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/FailingLoginLockPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/FailingLoginLockPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/FailingLoginLockPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!FilterDownParty": { "get": { "tags": [ "tenant filterdownparty" ], "summary": "Obsolete please use 'DownParties' instead.\nFilter application registration.", "operationId": "GetFilterDownParty", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter application registration name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DownParty" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DownParty" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DownParty" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterExternalUser": { "get": { "tags": [ "tenant filterexternaluser" ], "summary": "Obsolete please use 'ExternalUsers' instead.\nFilter external user.", "operationId": "GetFilterExternalUser", "parameters": [ { "name": "filterValue", "in": "query", "description": "Filter external user by link claim or user ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalUser" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalUser" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalUser" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterResourceName": { "get": { "tags": [ "tenant filterresourcename" ], "summary": "Obsolete please use 'ResourceNames' instead.\nFilter resource name or ID.", "operationId": "GetFilterResourceName", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter resource name or ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceName" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceName" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ResourceName" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterTenant": { "get": { "tags": [ "tenant filtertenant" ], "summary": "Obsolete please use 'Tenants' instead.\nFilter tenant.", "operationId": "GetFilterTenant", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter by tenant name.", "schema": { "type": "string" } }, { "name": "filterCustomDomain", "in": "query", "description": "Filter by custom domain.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterTrack": { "get": { "tags": [ "tenant filtertrack" ], "summary": "Obsolete please use 'Tracks' instead.\nFilter track.", "operationId": "GetFilterTrack", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter environment name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Track" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Track" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Track" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterUpParty": { "get": { "tags": [ "tenant filterupparty" ], "summary": "Obsolete please use 'UpParties' instead.\nFilter authentication method.", "operationId": "GetFilterUpParty", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter authentication method by name.", "schema": { "type": "string" } }, { "name": "filterHrdDomains", "in": "query", "description": "Filter authentication method by HRD domains.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UpParty" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UpParty" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UpParty" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterUsage": { "get": { "tags": [ "tenant filterusage" ], "summary": "Obsolete please use 'Usages' instead.\nFilter Usage.", "operationId": "GetFilterUsage", "parameters": [ { "name": "filterTenantName", "in": "query", "description": "Filter by tenant name.", "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "The year.", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "description": "The month.", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UsedBase" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UsedBase" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UsedBase" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterUsageTenant": { "get": { "tags": [ "tenant filterusagetenant" ], "summary": "Obsolete please use 'UsageTenants' instead.\nFilter usage tenant.", "operationId": "GetFilterUsageTenant", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter usage tenant name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!FilterUser": { "get": { "tags": [ "tenant filteruser" ], "summary": "Obsolete please use 'Users' instead.\nFilter user.", "operationId": "GetFilterUser", "parameters": [ { "name": "filterEmail", "in": "query", "description": "Filter user email.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/User" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/User" } } } } }, "404": { "description": "Not Found" } }, "deprecated": true } }, "/{tenant_name}/{track_name}/!LoginUpParty": { "get": { "tags": [ "tenant loginupparty" ], "summary": "Get Login authentication method.", "operationId": "GetLoginUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant loginupparty" ], "summary": "Create Login authentication method.", "operationId": "PostLoginUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Login authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant loginupparty" ], "summary": "Update Login authentication method.", "operationId": "PutLoginUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Login authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LoginUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant loginupparty" ], "summary": "Delete Login authentication method.", "operationId": "DeleteLoginUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!MyMollieFirstPayment": { "post": { "tags": [ "tenant mymolliefirstpayment" ], "summary": "Register first Mollie payment.", "operationId": "PostMyMollieFirstPayment", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "First payment.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MollieFirstPaymentResponse" } } } }, "409": { "description": "Conflict" } } } }, "/{tenant_name}/{track_name}/!MyTenant": { "get": { "tags": [ "tenant mytenant" ], "summary": "Get my tenant.", "operationId": "GetMyTenant", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant mytenant" ], "summary": "Update my tenant.", "operationId": "PutMyTenant", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyTenantRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant mytenant" ], "summary": "Delete my tenant.", "operationId": "DeleteMyTenant", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!MyTenantLog": { "get": { "tags": [ "tenant mytenantlog" ], "summary": "Get my tenant logs.", "operationId": "GetMyTenantLog", "parameters": [ { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "QueryExceptions", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryErrors", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryWarnings", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryTraces", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryEvents", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryMetrics", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!MyTenantLogAudit": { "get": { "tags": [ "tenant mytenantlogaudit" ], "summary": "Get my tenant audit logs.", "operationId": "GetMyTenantLogAudit", "parameters": [ { "name": "TenantName", "in": "query", "schema": { "maxLength": 50, "pattern": "^\\w[\\w\\-]*$", "type": "string" } }, { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!MyTenantLogUsage": { "get": { "tags": [ "tenant mytenantlogusage" ], "summary": "Get my tenant usage logs.", "operationId": "GetMyTenantLogUsage", "parameters": [ { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "TimeScope", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogTimeScopes" } }, { "name": "TimeOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SummarizeLevel", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogSummarizeLevels" } }, { "name": "IncludeTenants", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTracks", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUpParties", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUsers", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeLogins", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTokenRequests", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAdditional", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeControlApi", "in": "query", "schema": { "type": "boolean" } }, { "name": "OnlyDbQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!MyUser": { "get": { "tags": [ "tenant myuser" ], "summary": "Get my user.", "operationId": "GetMyUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyUser" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant myuser" ], "summary": "Update my user.\n - It is only possible to set the ChangePassword property.", "operationId": "PutMyUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "My user.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/MyUser" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "application/json": { "schema": { "$ref": "#/components/schemas/MyUser" } }, "text/json": { "schema": { "$ref": "#/components/schemas/MyUser" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!NewPartyName": { "get": { "tags": [ "tenant newpartyname" ], "summary": "Get new unique party name.", "operationId": "GetNewPartyName", "parameters": [ { "name": "isUpParty", "in": "query", "schema": { "type": "boolean", "default": false } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/NewPartyName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/NewPartyName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/NewPartyName" } } } } } } }, "/{tenant_name}/{track_name}/!OAuthClientSecretDownParty": { "get": { "tags": [ "tenant oauthclientsecretdownparty" ], "summary": "Get OAuth 2.0 client secrets for application registration.", "operationId": "GetOAuthClientSecretDownParty", "parameters": [ { "name": "partyName", "in": "query", "description": "OAuth 2.0 party name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oauthclientsecretdownparty" ], "summary": "Create OAuth 2.0 client secret for application registration.", "operationId": "PostOAuthClientSecretDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OAuth 2.0 client secret for application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "409": { "description": "Conflict" } } }, "delete": { "tags": [ "tenant oauthclientsecretdownparty" ], "summary": "Delete OAuth 2.0 client secret for application registration.", "operationId": "DeleteOAuthClientSecretDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name and secret id.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OAuthDownParty": { "get": { "tags": [ "tenant oauthdownparty" ], "summary": "Get OAuth 2.0 application registration.", "operationId": "GetOAuthDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oauthdownparty" ], "summary": "Create OAuth 2.0 application registration.", "operationId": "PostOAuthDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OAuth 2.0 application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant oauthdownparty" ], "summary": "Update OAuth 2.0 application registration.", "operationId": "PutOAuthDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OAuth 2.0 application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthDownParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant oauthdownparty" ], "summary": "Delete OAuth 2.0 application registration.", "operationId": "DeleteOAuthDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OAuthUpParty": { "get": { "tags": [ "tenant oauthupparty" ], "summary": "Get OAuth authentication method.", "operationId": "GetOAuthUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oauthupparty" ], "summary": "Create OAuth authentication method.", "operationId": "PostOAuthUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OAuth authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant oauthupparty" ], "summary": "Update OAuth authentication method.", "operationId": "PutOAuthUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OAuth authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant oauthupparty" ], "summary": "Delete OAuth authentication method.", "operationId": "DeleteOAuthUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OidcClientKeyUpParty": { "get": { "tags": [ "tenant oidcclientkeyupparty" ], "summary": "Get OIDC client key for authentication method.", "operationId": "GetOidcClientKeyUpParty", "parameters": [ { "name": "partyName", "in": "query", "description": "OIDC authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oidcclientkeyupparty" ], "summary": "Create OIDC client key for authentication method.", "operationId": "PostOidcClientKeyUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC client key for authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthClientKeyResponse" } } } }, "409": { "description": "Conflict" } } }, "delete": { "tags": [ "tenant oidcclientkeyupparty" ], "summary": "Delete OIDC client key for authentication method.", "operationId": "DeleteOidcClientKeyUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Name is [authentication method name].[key name]", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OidcClientSecretDownParty": { "get": { "tags": [ "tenant oidcclientsecretdownparty" ], "summary": "Get OIDC client secrets for application registration.", "operationId": "GetOidcClientSecretDownParty", "parameters": [ { "name": "partyName", "in": "query", "description": "OIDC application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretResponse" } } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oidcclientsecretdownparty" ], "summary": "Create OIDC client secret for application registration.", "operationId": "PostOidcClientSecretDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC client secret for application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "409": { "description": "Conflict" } } }, "delete": { "tags": [ "tenant oidcclientsecretdownparty" ], "summary": "Delete OIDC client secret for application registration.", "operationId": "DeleteOidcClientSecretDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name and secret id.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OidcClientSecretUpParty": { "get": { "tags": [ "tenant oidcclientsecretupparty" ], "summary": "Get OIDC client secret for authentication method.", "operationId": "GetOidcClientSecretUpParty", "parameters": [ { "name": "partyName", "in": "query", "description": "OIDC authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretSingleResponse" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretSingleResponse" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/OAuthClientSecretSingleResponse" } } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant oidcclientsecretupparty" ], "summary": "Update OIDC client secret for authentication method.", "operationId": "PutOidcClientSecretUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC client secret for authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretSingleRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretSingleRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OAuthClientSecretSingleRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OAuthUpParty" } } } }, "409": { "description": "Conflict" } } }, "delete": { "tags": [ "tenant oidcclientsecretupparty" ], "summary": "Delete OIDC client secret for authentication method.", "operationId": "DeleteOidcClientSecretUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OidcDownParty": { "get": { "tags": [ "tenant oidcdownparty" ], "summary": "Get OIDC application registration.", "operationId": "GetOidcDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oidcdownparty" ], "summary": "Create OIDC application registration.", "operationId": "PostOidcDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant oidcdownparty" ], "summary": "Update OIDC application registration.", "operationId": "PutOidcDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcDownParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant oidcdownparty" ], "summary": "Delete OIDC application registration.", "operationId": "DeleteOidcDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!OidcUpParty": { "get": { "tags": [ "tenant oidcupparty" ], "summary": "Get OIDC authentication method.", "operationId": "GetOidcUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant oidcupparty" ], "summary": "Create OIDC authentication method.", "operationId": "PostOidcUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant oidcupparty" ], "summary": "Update OIDC authentication method.\nYou cannot update the ClientSecret in this method.", "operationId": "PutOidcUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "OIDC authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/OidcUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant oidcupparty" ], "summary": "Delete OIDC authentication method.", "operationId": "DeleteOidcUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!PlanInfo": { "get": { "tags": [ "tenant planinfo" ], "summary": "Get list of plans.", "operationId": "GetPlanInfo", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PlanInfo" } } }, "application/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PlanInfo" } } }, "text/json": { "schema": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/PlanInfo" } } } } } } } }, "/{tenant_name}/{track_name}/!ReadCertificate": { "post": { "tags": [ "tenant readcertificate" ], "summary": "Read JWK with certificate information from PFX.", "operationId": "PostReadCertificate", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Base64 URL encode certificate and optionally password.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateAndPassword" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateAndPassword" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateAndPassword" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } } } } } } }, "/{tenant_name}/{track_name}/!ReadCertificateFromPem": { "post": { "tags": [ "tenant readcertificatefrompem" ], "summary": "Read JWK with certificate information from PEM certificate (.crt) and private key (.key).", "operationId": "PostReadCertificateFromPem", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "PEM certificate and private key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CertificateCrtAndKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CertificateCrtAndKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CertificateCrtAndKey" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "application/json": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "text/json": { "schema": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } } } } } } }, "/{tenant_name}/{track_name}/!RefreshTokenGrant": { "get": { "tags": [ "tenant refreshtokengrant" ], "summary": "Get refresh token grant.", "operationId": "GetRefreshTokenGrant", "parameters": [ { "name": "refreshToken", "in": "query", "description": "The refresh token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrant" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant refreshtokengrant" ], "summary": "Delete refresh token grant.", "operationId": "DeleteRefreshTokenGrant", "parameters": [ { "name": "refreshToken", "in": "query", "description": "The refresh token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!RefreshTokenGrants": { "get": { "tags": [ "tenant refreshtokengrants" ], "summary": "Get refresh token grants.", "operationId": "GetRefreshTokenGrants", "parameters": [ { "name": "filterUserIdentifier", "in": "query", "description": "Filter by the user identifier which can be: email, phone or username.", "schema": { "type": "string" } }, { "name": "filterSub", "in": "query", "description": "Filter by the users SUB claim.", "schema": { "type": "string" } }, { "name": "filterClientId", "in": "query", "description": "Filter by the applications client ID.", "schema": { "type": "string" } }, { "name": "filterUpPartyName", "in": "query", "description": "Filter by the authentication method.", "schema": { "type": "string" } }, { "name": "filterSessionId", "in": "query", "description": "Filter by session ID.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrantPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrantPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/RefreshTokenGrantPaginationResponse" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant refreshtokengrants" ], "summary": "Delete refresh token grants.", "operationId": "DeleteRefreshTokenGrants", "parameters": [ { "name": "userIdentifier", "in": "query", "description": "User identifier which can be: email, phone or username.", "schema": { "type": "string" } }, { "name": "sub", "in": "query", "description": "The users SUB claim.", "schema": { "type": "string" } }, { "name": "clientId", "in": "query", "description": "Applications client ID.", "schema": { "type": "string" } }, { "name": "upPartyName", "in": "query", "description": "Filter by the authentication method.", "schema": { "type": "string" } }, { "name": "sessionId", "in": "query", "description": "Filter by session ID.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!ResourceCultures": { "get": { "tags": [ "tenant resourcecultures" ], "summary": "Get resource cultures.", "operationId": "GetResourceCultures", "parameters": [ { "name": "paginationToken", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!ResourceNames": { "get": { "tags": [ "tenant resourcenames" ], "summary": "Get resource names and IDs.", "operationId": "GetResourceNames", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter resource name or ID.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!SamlDownParty": { "get": { "tags": [ "tenant samldownparty" ], "summary": "Get SAML 2.0 application registration.", "operationId": "GetSamlDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant samldownparty" ], "summary": "Create SAML 2.0 application registration.", "operationId": "PostSamlDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant samldownparty" ], "summary": "Update SAML 2.0 application registration.", "operationId": "PutSamlDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant samldownparty" ], "summary": "Delete SAML 2.0 application registration.", "operationId": "DeleteSamlDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!SamlDownPartyReadMetadata": { "post": { "tags": [ "tenant samldownpartyreadmetadata" ], "summary": "Read SAML 2.0 application registration metadata.", "operationId": "PostSamlDownPartyReadMetadata", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlDownParty" } } } } } } }, "/{tenant_name}/{track_name}/!SamlUpParty": { "get": { "tags": [ "tenant samlupparty" ], "summary": "Get SAML 2.0 authentication method.", "operationId": "GetSamlUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant samlupparty" ], "summary": "Create SAML 2.0 authentication method.", "operationId": "PostSamlUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant samlupparty" ], "summary": "Update SAML 2.0 authentication method.", "operationId": "PutSamlUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant samlupparty" ], "summary": "Delete SAML 2.0 authentication method.", "operationId": "DeleteSamlUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!SamlUpPartyReadMetadata": { "post": { "tags": [ "tenant samluppartyreadmetadata" ], "summary": "Read SAML 2.0 authentication method metadata.", "operationId": "PostSamlUpPartyReadMetadata", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "SAML 2.0 metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SamlReadMetadataRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SamlUpParty" } } } } } } }, "/{tenant_name}/{track_name}/!Tenant": { "get": { "tags": [ "tenant tenant" ], "summary": "Get tenant.", "operationId": "GetTenant", "parameters": [ { "name": "name", "in": "query", "description": "Tenant name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tenant" ], "summary": "Create tenant.", "operationId": "PostTenant", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateTenantRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant tenant" ], "summary": "Update tenant.", "operationId": "PutTenant", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Tenant.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TenantRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TenantRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantResponse" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant tenant" ], "summary": "Delete tenant.", "operationId": "DeleteTenant", "parameters": [ { "name": "name", "in": "query", "description": "Tenant name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TenantLog": { "get": { "tags": [ "tenant tenantlog" ], "summary": "Get tenant logs.", "operationId": "GetTenantLog", "parameters": [ { "name": "TenantName", "in": "query", "schema": { "maxLength": 50, "pattern": "^\\w[\\w\\-]*$", "type": "string" } }, { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "QueryExceptions", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryErrors", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryWarnings", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryTraces", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryEvents", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryMetrics", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TenantLogAudit": { "get": { "tags": [ "tenant tenantlogaudit" ], "summary": "Get tenant audit logs.", "operationId": "GetTenantLogAudit", "parameters": [ { "name": "TenantName", "in": "query", "schema": { "maxLength": 50, "pattern": "^\\w[\\w\\-]*$", "type": "string" } }, { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TenantLogUsage": { "get": { "tags": [ "tenant tenantlogusage" ], "summary": "Get tenant usage logs.", "operationId": "GetTenantLogUsage", "parameters": [ { "name": "TenantName", "in": "query", "schema": { "maxLength": 50, "pattern": "^\\w[\\w\\-]*$", "type": "string" } }, { "name": "TrackName", "in": "query", "schema": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string" } }, { "name": "TimeScope", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogTimeScopes" } }, { "name": "TimeOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SummarizeLevel", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogSummarizeLevels" } }, { "name": "IncludeTenants", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTracks", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUpParties", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUsers", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeLogins", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTokenRequests", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAdditional", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeControlApi", "in": "query", "schema": { "type": "boolean" } }, { "name": "OnlyDbQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Tenants": { "get": { "tags": [ "tenant tenants" ], "summary": "Get tenants.", "operationId": "GetTenants", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter by tenant name.", "schema": { "type": "string" } }, { "name": "filterCustomDomain", "in": "query", "description": "Filter by custom domain.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Track": { "get": { "tags": [ "tenant track" ], "summary": "Get environment.", "operationId": "GetTrack", "parameters": [ { "name": "name", "in": "query", "description": "Track name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant track" ], "summary": "Create environment.", "operationId": "PostTrack", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Track.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant track" ], "summary": "Update environment.", "operationId": "PutTrack", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Track.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Track" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Track" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant track" ], "summary": "Delete environment.", "operationId": "DeleteTrack", "parameters": [ { "name": "name", "in": "query", "description": "Track name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackClaimMapping": { "get": { "tags": [ "tenant trackclaimmapping" ], "summary": "Get environment claim mappings.", "operationId": "GetTrackClaimMapping", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant trackclaimmapping" ], "summary": "Save environment claim mappings.", "operationId": "PostTrackClaimMapping", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Claim mappings.", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "application/*+json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } }, "text/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ClaimMap" } } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackKeyContained": { "get": { "tags": [ "tenant trackkeycontained" ], "summary": "Get environment keys contained.", "operationId": "GetTrackKeyContained", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant trackkeycontained" ], "summary": "Update environment key contained.", "operationId": "PutTrackKeyContained", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Track key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant trackkeycontained" ], "summary": "Delete secondary environment key contained.", "operationId": "DeleteTrackKeyContained", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackKeyContainedSwap": { "post": { "tags": [ "tenant trackkeycontainedswap" ], "summary": "Swap environment key contained.", "operationId": "PostTrackKeyContainedSwap", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Track to swap.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedSwap" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedSwap" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemContainedSwap" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackKeyType": { "get": { "tags": [ "tenant trackkeytype" ], "summary": "Get environment key type.", "operationId": "GetTrackKeyType", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKeyItemsContained" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant trackkeytype" ], "summary": "Update environment key type.", "operationId": "PutTrackKeyType", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Track key.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKey" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackKey" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackKey" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackKey" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackKey" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLargeResource": { "get": { "tags": [ "tenant tracklargeresource" ], "summary": "Get a large resource.", "operationId": "GetTrackLargeResource", "parameters": [ { "name": "name", "in": "query", "description": "Large resource name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tracklargeresource" ], "summary": "Create a large resource.", "operationId": "PostTrackLargeResource", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Large resource to create.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant tracklargeresource" ], "summary": "Update a large resource.", "operationId": "PutTrackLargeResource", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Large resource to update.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItem" } } } }, "404": { "description": "Not Found" }, "409": { "description": "Conflict" } } }, "delete": { "tags": [ "tenant tracklargeresource" ], "summary": "Delete a large resource.", "operationId": "DeleteTrackLargeResource", "parameters": [ { "name": "name", "in": "query", "description": "Large resource name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" } } } }, "/{tenant_name}/{track_name}/!TrackLargeResources": { "get": { "tags": [ "tenant tracklargeresources" ], "summary": "Get large resources defined on the environment.", "operationId": "GetTrackLargeResources", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter by resource key.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "Pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItemPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItemPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLargeResourceItemPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLinkDownParty": { "get": { "tags": [ "tenant tracklinkdownparty" ], "summary": "Get environment link application registration.", "operationId": "GetTrackLinkDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tracklinkdownparty" ], "summary": "Create environment link application registration.", "operationId": "PostTrackLinkDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Environment Link application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant tracklinkdownparty" ], "summary": "Update environment link application registration.", "operationId": "PutTrackLinkDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Environment Link application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkDownParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant tracklinkdownparty" ], "summary": "Delete environment link application registration.", "operationId": "DeleteTrackLinkDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLinkUpParty": { "get": { "tags": [ "tenant tracklinkupparty" ], "summary": "Get environment link authentication method.", "operationId": "GetTrackLinkUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tracklinkupparty" ], "summary": "Create environment link authentication method.", "operationId": "PostTrackLinkUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Environment Link authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant tracklinkupparty" ], "summary": "Update environment link authentication method.", "operationId": "PutTrackLinkUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Environment Link authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackLinkUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant tracklinkupparty" ], "summary": "Delete environment link authentication method.", "operationId": "DeleteTrackLinkUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLog": { "get": { "tags": [ "tenant tracklog" ], "summary": "Get environment logs.", "operationId": "GetTrackLog", "parameters": [ { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "QueryExceptions", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryErrors", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryWarnings", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryTraces", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryEvents", "in": "query", "schema": { "type": "boolean" } }, { "name": "QueryMetrics", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLogAudit": { "get": { "tags": [ "tenant tracklogaudit" ], "summary": "Search audit logs for the current environment.", "operationId": "GetTrackLogAudit", "parameters": [ { "name": "FromTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "ToTime", "in": "query", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "name": "Filter", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLogSetting": { "get": { "tags": [ "tenant tracklogsetting" ], "summary": "Get environment log settings.", "operationId": "GetTrackLogSetting", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tracklogsetting" ], "summary": "Save environment log settings.", "operationId": "PostTrackLogSetting", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Log settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LogSettings" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogSettings" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLogStreamsSettings": { "get": { "tags": [ "tenant tracklogstreamssettings" ], "summary": "Get all environment log stream settings.", "operationId": "GetTrackLogStreamsSettings", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant tracklogstreamssettings" ], "summary": "Save all environment log stream settings.", "operationId": "PostTrackLogStreamsSettings", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "All log stream settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/LogStreams" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "application/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } }, "text/json": { "schema": { "$ref": "#/components/schemas/LogStreams" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackLogUsage": { "get": { "tags": [ "tenant tracklogusage" ], "summary": "Get environment usage logs.", "operationId": "GetTrackLogUsage", "parameters": [ { "name": "TimeScope", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogTimeScopes" } }, { "name": "TimeOffset", "in": "query", "schema": { "type": "integer", "format": "int32" } }, { "name": "SummarizeLevel", "in": "query", "required": true, "schema": { "$ref": "#/components/schemas/UsageLogSummarizeLevels" } }, { "name": "IncludeTenants", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTracks", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUpParties", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeUsers", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeLogins", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeTokenRequests", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeAdditional", "in": "query", "schema": { "type": "boolean" } }, { "name": "IncludeControlApi", "in": "query", "schema": { "type": "boolean" } }, { "name": "OnlyDbQuery", "in": "query", "schema": { "type": "boolean" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageLogResponse" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackOnlyResource": { "get": { "tags": [ "tenant trackonlyresource" ], "summary": "Get environment only resource.", "operationId": "GetTrackOnlyResource", "parameters": [ { "name": "resourceId", "in": "query", "description": "Resource id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant trackonlyresource" ], "summary": "Update environment only resource.", "operationId": "PutTrackOnlyResource", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Resource item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant trackonlyresource" ], "summary": "Delete environment only resource.", "operationId": "DeleteTrackOnlyResource", "parameters": [ { "name": "resourceId", "in": "query", "description": "Resource id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackOnlyResourceName": { "put": { "tags": [ "tenant trackonlyresourcename" ], "summary": "Update environment only resource name.", "operationId": "PutTrackOnlyResourceName", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Resource name.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceName" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant trackonlyresourcename" ], "summary": "Delete environment only resource name.", "operationId": "DeleteTrackOnlyResourceName", "parameters": [ { "name": "name", "in": "query", "description": "Resource name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackOnlyResourceNames": { "get": { "tags": [ "tenant trackonlyresourcenames" ], "summary": "Get environment only resource names and IDs.", "operationId": "GetTrackOnlyResourceNames", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter environment only resource name or ID.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceNamePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackResource": { "get": { "tags": [ "tenant trackresource" ], "summary": "Get environment resource.", "operationId": "GetTrackResource", "parameters": [ { "name": "resourceId", "in": "query", "description": "Resource id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant trackresource" ], "summary": "Update environment resource.", "operationId": "PutTrackResource", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Resource item.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant trackresource" ], "summary": "Delete environment resource.", "operationId": "DeleteTrackResource", "parameters": [ { "name": "resourceId", "in": "query", "description": "Resource id.", "schema": { "type": "integer", "format": "int32" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackResourceSetting": { "get": { "tags": [ "tenant trackresourcesetting" ], "summary": "Get environment resource settings.", "operationId": "GetTrackResourceSetting", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant trackresourcesetting" ], "summary": "Save environment resource settings.", "operationId": "PostTrackResourceSetting", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Resource settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceSettings" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Tracks": { "get": { "tags": [ "tenant tracks" ], "summary": "Get environments.", "operationId": "GetTracks", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter environment name.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackSendEmail": { "get": { "tags": [ "tenant tracksendemail" ], "summary": "Get environment send email.", "operationId": "GetTrackSendEmail", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant tracksendemail" ], "summary": "Update environment send email.", "operationId": "PutTrackSendEmail", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Send email.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendEmail" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendEmail" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendEmail" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant tracksendemail" ], "summary": "Delete environment send email.", "operationId": "DeleteTrackSendEmail", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!TrackSendSms": { "get": { "tags": [ "tenant tracksendsms" ], "summary": "Get environment send SMS settings.", "operationId": "GetTrackSendSms", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/ResourceItem" } } } }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant tracksendsms" ], "summary": "Update environment send SMS settings.", "operationId": "PutTrackSendSms", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Send SMS settings.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SendSms" } }, "text/json": { "schema": { "$ref": "#/components/schemas/SendSms" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/SendSms" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TrackResourceItem" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant tracksendsms" ], "summary": "Delete environment send SMS settings.", "operationId": "DeleteTrackSendSms", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UpParties": { "get": { "tags": [ "tenant upparties" ], "summary": "Get authentication methods.", "operationId": "GetUpParties", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter authentication method by name.", "schema": { "type": "string" } }, { "name": "filterHrdDomains", "in": "query", "description": "Filter authentication method by HRD domains.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UpPartyPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UpPartyPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpPartyPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Usage": { "get": { "tags": [ "tenant usage" ], "summary": "Get usage.", "operationId": "GetUsage", "parameters": [ { "name": "TenantName", "in": "query", "required": true, "schema": { "maxLength": 50, "pattern": "^[a-z0-9_][a-z0-9_-]*$", "type": "string" } }, { "name": "PeriodBeginDate", "in": "query", "required": true, "schema": { "type": "string", "format": "date" } }, { "name": "PeriodEndDate", "in": "query", "schema": { "type": "string", "format": "date" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Used" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Used" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Used" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant usage" ], "summary": "Create usage.", "operationId": "PostUsage", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Usage request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Used" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Used" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Used" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant usage" ], "summary": "Update usage.", "operationId": "PutUsage", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Usage request.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UpdateUsageRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Used" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Used" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Used" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant usage" ], "summary": "Delete usage.", "operationId": "DeleteUsage", "parameters": [ { "name": "name", "in": "query", "description": "Usage name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UsageInvoicingAction": { "post": { "tags": [ "tenant usageinvoicingaction" ], "summary": "Execute a usage invoicing action.", "operationId": "PostUsageInvoicingAction", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Usage invoicing action.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsageInvoicingAction" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsageInvoicingAction" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UsageInvoicingAction" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/Used" } }, "application/json": { "schema": { "$ref": "#/components/schemas/Used" } }, "text/json": { "schema": { "$ref": "#/components/schemas/Used" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Usages": { "get": { "tags": [ "tenant usages" ], "summary": "Get Usages.", "operationId": "GetUsages", "parameters": [ { "name": "filterTenantName", "in": "query", "description": "Filter by tenant name.", "schema": { "type": "string" } }, { "name": "year", "in": "query", "description": "The year.", "schema": { "type": "integer", "format": "int32" } }, { "name": "month", "in": "query", "description": "The month.", "schema": { "type": "integer", "format": "int32" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UsedBasePaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UsedBasePaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsedBasePaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UsageTenants": { "get": { "tags": [ "tenant usagetenants" ], "summary": "Get usage tenants.", "operationId": "GetUsageTenants", "parameters": [ { "name": "filterName", "in": "query", "description": "Filter usage tenant name.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/TenantPaginationResponse" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!User": { "get": { "tags": [ "tenant user" ], "summary": "Get user.", "operationId": "GetUser", "parameters": [ { "name": "email", "in": "query", "description": "Users email.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "Users phone.", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Users username.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant user" ], "summary": "Create user.\nValidate the password policy including password history update if a password is set. Not validated if the password is set with a password hash.\nProvide either a plaintext password or password hash fields, or omit the password entirely to create the user without credentials; do not send both password formats.", "operationId": "PostUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/CreateUserRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant user" ], "summary": "Update user.", "operationId": "PutUser", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant user" ], "summary": "Delete user.", "operationId": "DeleteUser", "parameters": [ { "name": "email", "in": "query", "description": "User email.", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "description": "User phone.", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "User username.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UserChangePassword": { "put": { "tags": [ "tenant userchangepassword" ], "summary": "Change the users password.", "operationId": "PutUserChangePassword", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User with current and new password.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserChangePasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserChangePasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserChangePasswordRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UserControlProfile": { "get": { "tags": [ "tenant usercontrolprofile" ], "summary": "Get user control profile.", "operationId": "GetUserControlProfile", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant usercontrolprofile" ], "summary": "Update user control profile.", "operationId": "PutUserControlProfile", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User control profile.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserControlProfile" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant usercontrolprofile" ], "summary": "Delete user control profile.", "operationId": "DeleteUserControlProfile", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UserPasswordHistory": { "get": { "tags": [ "tenant userpasswordhistory" ], "summary": "Get user password history.", "operationId": "GetUserPasswordHistory", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } }, { "name": "username", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant userpasswordhistory" ], "summary": "Replace user password history.", "operationId": "PutUserPasswordHistory", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistoryRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistoryRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistoryRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPasswordHistory" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant userpasswordhistory" ], "summary": "Delete user password history.", "operationId": "DeleteUserPasswordHistory", "parameters": [ { "name": "email", "in": "query", "schema": { "type": "string" } }, { "name": "phone", "in": "query", "schema": { "type": "string" } }, { "name": "username", "in": "query", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!Users": { "get": { "tags": [ "tenant users" ], "summary": "Get users.", "operationId": "GetUsers", "parameters": [ { "name": "filterEmail", "in": "query", "description": "Filter by email.", "schema": { "type": "string" } }, { "name": "filterPhone", "in": "query", "description": "Filter by phone.", "schema": { "type": "string" } }, { "name": "filterUsername", "in": "query", "description": "Filter by username.", "schema": { "type": "string" } }, { "name": "filterUserId", "in": "query", "description": "Filter by user ID.", "schema": { "type": "string" } }, { "name": "filterClaimValue", "in": "query", "description": "Filter by claim value.", "schema": { "type": "string" } }, { "name": "paginationToken", "in": "query", "description": "The pagination token.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/UserPaginationResponse" } }, "application/json": { "schema": { "$ref": "#/components/schemas/UserPaginationResponse" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserPaginationResponse" } } } }, "404": { "description": "Not Found" } } }, "put": { "tags": [ "tenant users" ], "summary": "Create new users or override existing users. It is not possible to update user identifies (username/phone/email) in this API method.\nValidate the password policy if a password is set. Not validated if the password is set with a password hash. Password history is not validated or update because existing users are overridden.\nEach user entry can either include a plaintext password, password hash fields, or no password at all, and the choice is independent per user; do not submit both password formats for the same user.", "operationId": "PutUsers", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsersRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UsersRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "423": { "description": "Locked" } } }, "delete": { "tags": [ "tenant users" ], "summary": "Delete users.", "operationId": "DeleteUsers", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Delete specified users.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UsersDelete" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UsersDelete" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UsersDelete" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!UserSetPassword": { "put": { "tags": [ "tenant usersetpassword" ], "summary": "Set the users password.\nValidate the password policy including password history update if a password is set. Not validated if the password is set with a password hash.\nYou can set a plaintext password, provide password hash fields, or leave the password fields empty to remove the current password; never include both password formats in the same request.", "operationId": "PutUserSetPassword", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "User password.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserSetPasswordRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/UserSetPasswordRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/UserSetPasswordRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/User" } }, "application/json": { "schema": { "$ref": "#/components/schemas/User" } }, "text/json": { "schema": { "$ref": "#/components/schemas/User" } } } }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!WsFedDownParty": { "get": { "tags": [ "tenant wsfeddownparty" ], "summary": "Get WS-Federation application registration.", "operationId": "GetWsFedDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant wsfeddownparty" ], "summary": "Create WS-Federation application registration.", "operationId": "PostWsFedDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant wsfeddownparty" ], "summary": "Update WS-Federation application registration.", "operationId": "PutWsFedDownParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation application registration.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant wsfeddownparty" ], "summary": "Delete WS-Federation application registration.", "operationId": "DeleteWsFedDownParty", "parameters": [ { "name": "name", "in": "query", "description": "Application name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!WsFedDownPartyReadMetadata": { "post": { "tags": [ "tenant wsfeddownpartyreadmetadata" ], "summary": "Read WS-Federation application registration metadata.", "operationId": "PostWsFedDownPartyReadMetadata", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedDownParty" } } } } } } }, "/{tenant_name}/{track_name}/!WsFedUpParty": { "get": { "tags": [ "tenant wsfedupparty" ], "summary": "Get WS-Federation authentication method.", "operationId": "GetWsFedUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } }, "404": { "description": "Not Found" } } }, "post": { "tags": [ "tenant wsfedupparty" ], "summary": "Create WS-Federation authentication method.", "operationId": "PostWsFedUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "201": { "description": "Created", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } }, "423": { "description": "Locked" }, "409": { "description": "Conflict" } } }, "put": { "tags": [ "tenant wsfedupparty" ], "summary": "Update WS-Federation authentication method.", "operationId": "PutWsFedUpParty", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation authentication method.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } }, "404": { "description": "Not Found" } } }, "delete": { "tags": [ "tenant wsfedupparty" ], "summary": "Delete WS-Federation authentication method.", "operationId": "DeleteWsFedUpParty", "parameters": [ { "name": "name", "in": "query", "description": "Authentication method name.", "schema": { "type": "string" } }, { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "204": { "description": "No Content" }, "404": { "description": "Not Found" } } } }, "/{tenant_name}/{track_name}/!WsFedUpPartyReadMetadata": { "post": { "tags": [ "tenant wsfeduppartyreadmetadata" ], "summary": "Read WS-Federation authentication method metadata.", "operationId": "PostWsFedUpPartyReadMetadata", "parameters": [ { "name": "tenant_name", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "track_name", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "WS-Federation metadata.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } }, "application/*+json": { "schema": { "$ref": "#/components/schemas/WsFedReadMetadataRequest" } } } }, "responses": { "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "400": { "description": "Bad Request" }, "500": { "description": "Internal Server Error" }, "200": { "description": "OK", "content": { "text/plain": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "application/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } }, "text/json": { "schema": { "$ref": "#/components/schemas/WsFedUpParty" } } } } } } }, "/health": { "get": { "tags": [ "health" ], "summary": "Returns current health status for monitoring systems.", "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AccessStructure": { "required": [ "id", "name", "nodes", "rootNodeId" ], "type": "object", "properties": { "id": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "pattern": "^[\\w\\-\\(\\)\\[\\]\\{\\} ]*$", "type": "string" }, "rootNodeId": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "nodes": { "maximum": 2000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/AccessStructureNode" } }, "forwardClaims": { "type": "boolean" } }, "additionalProperties": false }, "AccessStructureClaim": { "required": [ "claim" ], "type": "object", "properties": { "claim": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string" }, "values": { "maximum": 10, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AccessStructureMembership": { "required": [ "accessStructureId", "nodeId" ], "type": "object", "properties": { "accessStructureId": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "nodeId": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "validFrom": { "type": "integer", "format": "int64", "nullable": true }, "validTo": { "type": "integer", "format": "int64", "nullable": true }, "accessStructureName": { "type": "string", "nullable": true }, "nodeName": { "type": "string", "nullable": true } }, "additionalProperties": false }, "AccessStructureMembershipRequest": { "required": [ "accessStructureId", "nodeId" ], "type": "object", "properties": { "accessStructureId": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "nodeId": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "validFrom": { "type": "integer", "format": "int64", "nullable": true }, "validTo": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "AccessStructureMembershipsResponse": { "required": [ "userId", "userType" ], "type": "object", "properties": { "userType": { "$ref": "#/components/schemas/UserTypes" }, "userId": { "maxLength": 40, "minLength": 1, "type": "string" }, "userDisplayName": { "type": "string", "nullable": true }, "memberships": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/AccessStructureMembership" }, "nullable": true }, "resolvedNodes": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resolvedClaims": { "type": "array", "items": { "type": "string" }, "nullable": true }, "resolvedPathClaims": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "AccessStructureMembershipsUpdateRequest": { "required": [ "userId", "userType" ], "type": "object", "properties": { "userType": { "$ref": "#/components/schemas/UserTypes" }, "userId": { "maxLength": 40, "minLength": 1, "type": "string" }, "memberships": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/AccessStructureMembershipRequest" }, "nullable": true } }, "additionalProperties": false }, "AccessStructureNode": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "maxLength": 10, "minLength": 1, "pattern": "^[a-z0-9]*$", "type": "string" }, "name": { "maxLength": 80, "minLength": 1, "pattern": "^[\\w\\-\\(\\)\\[\\]\\{\\} ]*$", "type": "string" }, "parentNodeId": { "maxLength": 10, "pattern": "^[a-z0-9]*$", "type": "string", "nullable": true }, "passwordPolicyName": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "requireMultiFactor": { "type": "boolean" }, "disableAccount": { "type": "boolean" }, "claims": { "maximum": 50, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/AccessStructureClaim" }, "nullable": true } }, "additionalProperties": false }, "AccessStructurePaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/AccessStructure" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActiveSession": { "required": [ "createTime", "sessionId" ], "type": "object", "properties": { "sessionId": { "maxLength": 200, "minLength": 1, "type": "string" }, "sub": { "maxLength": 10000, "type": "string", "nullable": true }, "subFormat": { "maxLength": 10000, "type": "string", "nullable": true }, "email": { "maxLength": 10000, "type": "string", "nullable": true }, "phone": { "maxLength": 10000, "type": "string", "nullable": true }, "username": { "maxLength": 10000, "type": "string", "nullable": true }, "upPartyLinks": { "type": "array", "items": { "$ref": "#/components/schemas/PartyNameSessionLink" }, "nullable": true }, "sessionUpParty": { "$ref": "#/components/schemas/PartyNameSessionLink" }, "downPartyLinks": { "type": "array", "items": { "$ref": "#/components/schemas/PartyNameSessionLink" }, "nullable": true }, "clientIp": { "maxLength": 10000, "type": "string", "nullable": true }, "userAgent": { "maxLength": 10000, "type": "string", "nullable": true }, "createTime": { "type": "integer", "format": "int64" }, "lastUpdated": { "type": "integer", "format": "int64" }, "timeToLive": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ActiveSessionPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ActiveSession" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "CertificateAndPassword": { "required": [ "encodeCertificate" ], "type": "object", "properties": { "encodeCertificate": { "maxLength": 20000, "minLength": 1, "type": "string" }, "password": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "CertificateCrtAndKey": { "required": [ "certificatePemCrt", "certificatePemKey" ], "type": "object", "properties": { "certificatePemCrt": { "maxLength": 20000, "minLength": 1, "type": "string" }, "certificatePemKey": { "maxLength": 20000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "CertificateInfo": { "type": "object", "properties": { "subject": { "type": "string", "nullable": true }, "validFrom": { "type": "string", "format": "date-time" }, "validTo": { "type": "string", "format": "date-time" }, "thumbprint": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ClaimAndValues": { "required": [ "claim" ], "type": "object", "properties": { "claim": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string" }, "values": { "maximum": 100, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "ClaimMap": { "required": [ "jwtClaim", "samlClaim" ], "type": "object", "properties": { "jwtClaim": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string" }, "samlClaim": { "maxLength": 300, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string" } }, "additionalProperties": false }, "ClaimTransformActions": { "enum": [ "If", "IfNot", "Add", "AddIfNot", "AddIfNotOut", "Replace", "ReplaceIfNot", "Remove" ], "type": "string" }, "ClaimTransformTasks": { "enum": [ "RequestException", "UpPartyAction", "QueryInternalUser", "QueryExternalUser", "SaveClaimInternalUser", "SaveClaimExternalUser", "LogEvent" ], "type": "string", "nullable": true }, "ClaimTransformTypes": { "enum": [ "Constant", "MatchClaim", "Match", "RegexMatch", "Map", "RegexMap", "Concatenate", "ExternalClaims", "DkPrivilege" ], "type": "string" }, "ClientAuthenticationMethods": { "enum": [ "ClientSecretPost", "ClientSecretBasic", "PrivateKeyJwt" ], "type": "string" }, "ClientKey": { "required": [ "externalName", "publicKey", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/ClientKeyTypes" }, "externalName": { "minLength": 1, "type": "string" }, "publicKey": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "additionalProperties": false }, "ClientKeyTypes": { "enum": [ "Contained", "KeyVaultImport" ], "type": "string" }, "ControlClientSettings": { "type": "object", "properties": { "foxIDsEndpoint": { "type": "string", "nullable": true }, "version": { "type": "string", "nullable": true }, "fullVersion": { "type": "string", "nullable": true }, "logOption": { "$ref": "#/components/schemas/LogOptions" }, "keyStorageOption": { "$ref": "#/components/schemas/KeyStorageOptions" }, "enableCreateNewTenant": { "type": "boolean" }, "enablePayment": { "type": "boolean" }, "paymentTestMode": { "type": "boolean" }, "currency": { "type": "string", "nullable": true }, "mollieProfileId": { "type": "string", "nullable": true }, "clientUi": { "$ref": "#/components/schemas/ControlClientUiSettings" }, "moduleAssets": { "$ref": "#/components/schemas/ModuleAssetsSettings" } }, "additionalProperties": false }, "ControlClientUiSettings": { "type": "object", "properties": { "hideBrandingSettings": { "type": "boolean" }, "hideSmsSettings": { "type": "boolean" }, "hideMailSettings": { "type": "boolean" } }, "additionalProperties": false }, "CreateTenantRequest": { "required": [ "administratorEmail", "controlClientBaseUri", "name" ], "type": "object", "properties": { "planName": { "maxLength": 30, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "customDomain": { "maxLength": 200, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "pattern": "^\\w[\\w\\-]*$", "type": "string" }, "customDomainVerified": { "type": "boolean" }, "forUsage": { "type": "boolean" }, "enableUsage": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "maxLength": 3, "type": "string", "nullable": true }, "includeVat": { "type": "boolean" }, "hourPrice": { "type": "number", "format": "double", "nullable": true }, "administratorEmail": { "maxLength": 60, "minLength": 1, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email" }, "administratorPassword": { "maxLength": 50, "type": "string", "format": "password", "nullable": true }, "setAdministratorPasswordEmail": { "type": "boolean" }, "changeAdministratorPassword": { "type": "boolean" }, "confirmAdministratorAccount": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "controlClientBaseUri": { "maxLength": 400, "minLength": 1, "type": "string" }, "customer": { "$ref": "#/components/schemas/Customer" } }, "additionalProperties": false }, "CreateUser": { "type": "object", "properties": { "confirmAccount": { "type": "boolean" }, "requireMultiFactor": { "type": "boolean" }, "elements": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/DynamicElement" }, "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true } }, "additionalProperties": false }, "CreateUserRequest": { "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "directoryUserId": { "maxLength": 50, "pattern": "^[\\p{L}0-9:\\-_.+@/=]*$", "type": "string", "nullable": true }, "confirmAccount": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" }, "changePassword": { "type": "boolean" }, "disableSetPasswordSms": { "type": "boolean" }, "disableSetPasswordEmail": { "type": "boolean" }, "setPasswordEmail": { "type": "boolean" }, "setPasswordSms": { "type": "boolean" }, "passwordPolicyName": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "disableAccount": { "type": "boolean" }, "disableTwoFactorApp": { "type": "boolean" }, "disableTwoFactorSms": { "type": "boolean" }, "disableTwoFactorEmail": { "type": "boolean" }, "requireMultiFactor": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "password": { "maxLength": 50, "type": "string", "format": "password", "nullable": true }, "passwordHashAlgorithm": { "maxLength": 20, "type": "string", "nullable": true }, "passwordHash": { "maxLength": 2048, "type": "string", "nullable": true }, "passwordHashSalt": { "maxLength": 512, "type": "string", "nullable": true }, "passwordLastChanged": { "maximum": 9.223372036854776E+18, "minimum": 0, "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Customer": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 60, "minLength": 1, "type": "string" }, "vatNumber": { "maxLength": 50, "type": "string", "nullable": true }, "addressLine1": { "maxLength": 50, "type": "string", "nullable": true }, "addressLine2": { "maxLength": 50, "type": "string", "nullable": true }, "postalCode": { "maxLength": 50, "type": "string", "nullable": true }, "city": { "maxLength": 50, "type": "string", "nullable": true }, "stateRegion": { "maxLength": 50, "type": "string", "nullable": true }, "country": { "maxLength": 50, "type": "string", "nullable": true }, "invoiceEmails": { "maximum": 5, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "reference": { "maxLength": 60, "type": "string", "nullable": true } }, "additionalProperties": false }, "DirectoryConnector": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "saveLocalPassword": { "type": "boolean" }, "enablePasswordPolicy": { "type": "boolean" }, "externalConnectType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "secretLoaded": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "DownParty": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PartyTypes" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "DownPartyPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/DownParty" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DownPartyTestResultRequest": { "required": [ "code", "state" ], "type": "object", "properties": { "state": { "maxLength": 2000, "minLength": 1, "type": "string" }, "code": { "maxLength": 4000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "DownPartyTestResultResponse": { "required": [ "accessToken", "idToken" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "idTokenClaims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "accessTokenClaims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "idToken": { "maxLength": 256000, "minLength": 1, "type": "string" }, "accessToken": { "maxLength": 256000, "minLength": 1, "type": "string" }, "endSessionUrl": { "maxLength": 10240, "type": "string", "nullable": true }, "testUrl": { "maxLength": 10240, "type": "string", "nullable": true }, "testExpireAt": { "type": "integer", "format": "int64" }, "testExpireInSeconds": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DownPartyTestStartRequest": { "required": [ "redirectUri", "responseMode" ], "type": "object", "properties": { "upParties": { "maximum": 200, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "claims": { "maximum": 100, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUri": { "maxLength": 500, "minLength": 1, "type": "string" }, "responseMode": { "maxLength": 30, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "DownPartyTestStartResponse": { "required": [ "testUrl" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "testUrl": { "maxLength": 10240, "minLength": 1, "type": "string" }, "testExpireAt": { "type": "integer", "format": "int64" }, "testExpireInSeconds": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "DynamicElement": { "required": [ "order", "type" ], "type": "object", "properties": { "name": { "maxLength": 20, "pattern": "^\\w[\\w\\-]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/DynamicElementTypes" }, "order": { "maximum": 100, "minimum": 0, "type": "integer", "format": "int32" }, "required": { "type": "boolean" }, "isUserIdentifier": { "type": "boolean" }, "content": { "maxLength": 500, "type": "string", "nullable": true }, "displayName": { "maxLength": 50, "type": "string", "nullable": true }, "maxLength": { "type": "integer", "format": "int32" }, "regEx": { "maxLength": 300, "type": "string", "nullable": true }, "errorMessage": { "maxLength": 500, "type": "string", "nullable": true }, "claimOut": { "maxLength": 100, "pattern": "^[\\w:\\/\\-.+ \\*]*$", "type": "string", "nullable": true } }, "additionalProperties": false }, "DynamicElementTypes": { "enum": [ "Email", "Phone", "Username", "EmailAndPassword", "Password", "Name", "GivenName", "FamilyName", "Text", "Html", "LargeText", "LargeHtml", "Checkbox", "Custom", "LoginInput", "LoginButton", "LoginLink", "LoginHrd" ], "type": "string" }, "ExtendedUi": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^\\w[\\w\\-]*$", "type": "string" }, "title": { "maxLength": 100, "type": "string", "nullable": true }, "submitButtonText": { "maxLength": 50, "type": "string", "nullable": true }, "moduleType": { "$ref": "#/components/schemas/ExtendedUiModuleTypes" }, "modules": { "$ref": "#/components/schemas/ExtendedUiModules" }, "elements": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/DynamicElement" }, "nullable": true }, "externalConnectType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "externalClaimsIn": { "maximum": 1000, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "secretLoaded": { "maxLength": 300, "type": "string", "nullable": true }, "errorMessage": { "maxLength": 500, "type": "string", "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true } }, "additionalProperties": false }, "ExtendedUiModuleTypes": { "enum": [ "NemLoginPrivateCprMatch" ], "type": "string" }, "ExtendedUiModules": { "type": "object", "properties": { "nemLogin": { "$ref": "#/components/schemas/ExtendedUiNemLoginModule" } }, "additionalProperties": false }, "ExtendedUiNemLoginModule": { "required": [ "environment" ], "type": "object", "properties": { "environment": { "$ref": "#/components/schemas/NemLoginEnvironments" } }, "additionalProperties": false }, "ExternalConnectTypes": { "enum": [ "Api" ], "type": "string", "nullable": true }, "ExternalLoginSecretRequest": { "required": [ "partyName", "secret" ], "type": "object", "properties": { "partyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "secret": { "maxLength": 300, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "ExternalLoginSecretResponse": { "type": "object", "properties": { "info": { "maxLength": 3, "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalLoginUpParty": { "required": [ "externalLoginType", "usernameType" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "externalLoginType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "usernameType": { "$ref": "#/components/schemas/ExternalLoginUsernameTypes" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true }, "enableCancelLogin": { "type": "boolean" }, "logoutConsent": { "$ref": "#/components/schemas/LoginUpPartyLogoutConsents" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "externalUserLoadedClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true, "deprecated": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "title": { "maxLength": 40, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "iconUrl": { "maxLength": 10000, "type": "string", "nullable": true }, "css": { "maxLength": 40000, "type": "string", "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "linkExternalUser": { "$ref": "#/components/schemas/LinkExternalUser" }, "profiles": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExternalLoginUpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "ExternalLoginUpPartyProfile": { "required": [ "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "newName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true } }, "additionalProperties": false }, "ExternalLoginUsernameTypes": { "enum": [ "Email", "Text" ], "type": "string" }, "ExternalPassword": { "type": "object", "properties": { "enabledValidationCurrent": { "type": "boolean" }, "enabledValidationNew": { "type": "boolean" }, "enabledNotificationCurrent": { "type": "boolean" }, "enabledNotificationNew": { "type": "boolean" }, "externalConnectType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "secretLoaded": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "ExternalUser": { "required": [ "upPartyName", "userId" ], "type": "object", "properties": { "upPartyName": { "maxLength": 50, "minLength": 1, "type": "string" }, "linkClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "redemptionClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "userId": { "maxLength": 40, "minLength": 1, "type": "string" }, "expireAt": { "type": "integer", "format": "int64", "nullable": true }, "disableAccount": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true } }, "additionalProperties": false }, "ExternalUserPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ExternalUser" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ExternalUserRequest": { "required": [ "upPartyName" ], "type": "object", "properties": { "upPartyName": { "maxLength": 50, "minLength": 1, "type": "string" }, "linkClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "redemptionClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "disableAccount": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true } }, "additionalProperties": false }, "ExternalUserUpdateRequest": { "required": [ "upPartyName" ], "type": "object", "properties": { "upPartyName": { "maxLength": 50, "minLength": 1, "type": "string" }, "linkClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "redemptionClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "disableAccount": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "updateUpPartyName": { "maxLength": 50, "type": "string", "nullable": true }, "updateLinkClaimValue": { "maxLength": 10000, "type": "string", "nullable": true }, "updateRedemptionClaimValue": { "maxLength": 10000, "type": "string", "nullable": true } }, "additionalProperties": false }, "FailingLoginLock": { "required": [ "createTime", "failingLoginType", "timeToLive", "userIdentifier" ], "type": "object", "properties": { "userIdentifier": { "maxLength": 60, "minLength": 1, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string" }, "failingLoginType": { "$ref": "#/components/schemas/FailingLoginTypes" }, "createTime": { "type": "integer", "format": "int64" }, "timeToLive": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FailingLoginLockPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/FailingLoginLock" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "FailingLoginTypes": { "enum": [ "InternalLogin", "ExternalLogin", "SmsCode", "EmailCode", "TwoFactorSmsCode", "TwoFactorEmailCode", "TwoFactorAuthenticator" ], "type": "string" }, "Invoice": { "required": [ "currency", "invoiceNumber", "issueDate" ], "type": "object", "properties": { "isCardPayment": { "type": "boolean" }, "isCreditNote": { "type": "boolean" }, "sendStatus": { "$ref": "#/components/schemas/UsageInvoiceSendStatus" }, "invoiceNumber": { "minLength": 1, "type": "string" }, "issueDate": { "type": "string", "format": "date" }, "dueDate": { "type": "string", "format": "date", "nullable": true }, "currency": { "maxLength": 3, "minLength": 1, "type": "string" }, "lines": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/InvoiceLine" }, "nullable": true }, "price": { "type": "number", "format": "double" }, "vat": { "type": "number", "format": "double" }, "totalPrice": { "type": "number", "format": "double" }, "timeItems": { "maximum": 1000, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsedItem" }, "nullable": true } }, "additionalProperties": false }, "InvoiceLine": { "type": "object", "properties": { "text": { "maxLength": 300, "type": "string", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "JsonWebKey": { "type": "object", "properties": { "kty": { "type": "string", "nullable": true }, "use": { "type": "string", "nullable": true }, "keyOps": { "type": "array", "items": { "type": "string" }, "nullable": true }, "alg": { "type": "string", "nullable": true }, "kid": { "type": "string", "nullable": true }, "x5u": { "type": "string", "nullable": true }, "x5c": { "type": "array", "items": { "type": "string" }, "nullable": true }, "x5t": { "type": "string", "nullable": true }, "x5tS256": { "type": "string", "nullable": true }, "n": { "type": "string", "nullable": true }, "e": { "type": "string", "nullable": true }, "d": { "type": "string", "nullable": true }, "p": { "type": "string", "nullable": true }, "q": { "type": "string", "nullable": true }, "dp": { "type": "string", "nullable": true }, "dq": { "type": "string", "nullable": true }, "qi": { "type": "string", "nullable": true }, "crv": { "type": "string", "nullable": true }, "x": { "type": "string", "nullable": true }, "y": { "type": "string", "nullable": true } }, "additionalProperties": false }, "JwkWithCertificateInfo": { "type": "object", "properties": { "kty": { "type": "string", "nullable": true }, "use": { "type": "string", "nullable": true }, "keyOps": { "type": "array", "items": { "type": "string" }, "nullable": true }, "alg": { "type": "string", "nullable": true }, "kid": { "type": "string", "nullable": true }, "x5u": { "type": "string", "nullable": true }, "x5c": { "type": "array", "items": { "type": "string" }, "nullable": true }, "x5t": { "type": "string", "nullable": true }, "x5tS256": { "type": "string", "nullable": true }, "n": { "type": "string", "nullable": true }, "e": { "type": "string", "nullable": true }, "d": { "type": "string", "nullable": true }, "p": { "type": "string", "nullable": true }, "q": { "type": "string", "nullable": true }, "dp": { "type": "string", "nullable": true }, "dq": { "type": "string", "nullable": true }, "qi": { "type": "string", "nullable": true }, "crv": { "type": "string", "nullable": true }, "x": { "type": "string", "nullable": true }, "y": { "type": "string", "nullable": true }, "certificateInfo": { "$ref": "#/components/schemas/CertificateInfo" } }, "additionalProperties": false }, "KeyStorageOptions": { "enum": [ "None", "KeyVault" ], "type": "string" }, "LinkExternalUser": { "required": [ "linkClaimType" ], "type": "object", "properties": { "autoCreateUser": { "type": "boolean" }, "requireUser": { "type": "boolean" }, "externalUserLifetime": { "type": "integer", "format": "int32" }, "linkClaimType": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string" }, "redemptionClaimType": { "maxLength": 100, "pattern": "^[\\w:\\/\\-.+ ]*$", "type": "string", "nullable": true }, "overwriteClaims": { "type": "boolean" }, "elements": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/DynamicElement" }, "nullable": true }, "upPartyClaims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true } }, "additionalProperties": false }, "LogItem": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/LogItemTypes" }, "timestamp": { "type": "integer", "format": "int64" }, "sequenceId": { "type": "string", "nullable": true }, "operationId": { "type": "string", "nullable": true }, "values": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "nullable": true }, "details": { "type": "array", "items": { "$ref": "#/components/schemas/LogItemDetail" }, "nullable": true }, "subItems": { "type": "array", "items": { "$ref": "#/components/schemas/LogItem" }, "nullable": true } }, "additionalProperties": false }, "LogItemDetail": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "traceType": { "type": "string", "nullable": true }, "details": { "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "LogItemTypes": { "enum": [ "Sequence", "Operation", "Warning", "Error", "CriticalError", "Trace", "Event", "Metric" ], "type": "string" }, "LogLifetimeOptions": { "enum": [ "Max30Days", "Max180Days" ], "type": "string" }, "LogOptions": { "enum": [ "Stdout", "OpenSearchAndStdoutErrors", "ApplicationInsights" ], "type": "string" }, "LogResponse": { "type": "object", "properties": { "items": { "type": "array", "items": { "$ref": "#/components/schemas/LogItem" }, "nullable": true }, "responseTruncated": { "type": "boolean" } }, "additionalProperties": false }, "LogSettings": { "type": "object", "properties": { "logInfoTrace": { "type": "boolean" }, "logClaimTrace": { "type": "boolean" }, "logMessageTrace": { "type": "boolean" }, "logMetric": { "type": "boolean" } }, "additionalProperties": false }, "LogStreamApplicationInsightsSettings": { "required": [ "connectionString" ], "type": "object", "properties": { "connectionString": { "maxLength": 4096, "minLength": 1, "pattern": "^[\\w\\-=.:;\\/]*$", "type": "string" } }, "additionalProperties": false }, "LogStreamSettings": { "required": [ "type" ], "type": "object", "properties": { "logInfoTrace": { "type": "boolean" }, "logClaimTrace": { "type": "boolean" }, "logMessageTrace": { "type": "boolean" }, "logMetric": { "type": "boolean" }, "type": { "$ref": "#/components/schemas/LogStreamTypes" }, "logWarning": { "type": "boolean" }, "logError": { "type": "boolean" }, "logCriticalError": { "type": "boolean" }, "logEvent": { "type": "boolean" }, "applicationInsightsSettings": { "$ref": "#/components/schemas/LogStreamApplicationInsightsSettings" } }, "additionalProperties": false }, "LogStreamTypes": { "enum": [ "ApplicationInsights" ], "type": "string" }, "LogStreams": { "type": "object", "properties": { "logStreamSettings": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/LogStreamSettings" }, "nullable": true } }, "additionalProperties": false }, "LoginUpParty": { "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "enableEmailIdentifier": { "type": "boolean" }, "enablePhoneIdentifier": { "type": "boolean" }, "enableUsernameIdentifier": { "type": "boolean" }, "disablePasswordAuth": { "type": "boolean", "nullable": true }, "enablePasswordlessEmail": { "type": "boolean", "nullable": true }, "enablePasswordlessSms": { "type": "boolean", "nullable": true }, "enableCancelLogin": { "type": "boolean" }, "enableCreateUser": { "type": "boolean" }, "disableSetPassword": { "type": "boolean", "nullable": true, "deprecated": true }, "disableSetPasswordSms": { "type": "boolean" }, "disableSetPasswordEmail": { "type": "boolean" }, "deleteRefreshTokenGrantsOnChangePassword": { "type": "boolean" }, "deleteActiveSessionOnChangePassword": { "type": "boolean" }, "logoutConsent": { "$ref": "#/components/schemas/LoginUpPartyLogoutConsents" }, "disableTwoFactorApp": { "type": "boolean" }, "disableTwoFactorSms": { "type": "boolean" }, "disableTwoFactorEmail": { "type": "boolean" }, "twoFactorAppName": { "maxLength": 50, "type": "string", "nullable": true }, "requireTwoFactor": { "type": "boolean", "nullable": true, "deprecated": true }, "requireMfaFactor": { "type": "boolean" }, "enableMultiFactor": { "type": "boolean" }, "multiFactorItems": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/MultiFactorItem" }, "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "title": { "maxLength": 40, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "iconUrl": { "maxLength": 10000, "type": "string", "nullable": true }, "css": { "maxLength": 40000, "type": "string", "nullable": true }, "elements": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/DynamicElement" }, "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "createUser": { "$ref": "#/components/schemas/CreateUser" } }, "additionalProperties": false }, "LoginUpPartyLogoutConsents": { "enum": [ "Always", "IfRequired", "Never" ], "type": "string" }, "ModuleAssetsSettings": { "type": "object", "properties": { "nemLogin": { "$ref": "#/components/schemas/NemLoginAssetsSettings" } }, "additionalProperties": false }, "MollieFirstPaymentRequest": { "type": "object", "properties": { "cardToken": { "maxLength": 100, "type": "string", "nullable": true } }, "additionalProperties": false }, "MollieFirstPaymentResponse": { "type": "object", "properties": { "checkoutUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "MultiFactorItem": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/MultiFactorTypes" }, "amr": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "upParty": { "$ref": "#/components/schemas/MultiFactorUpParty" } }, "additionalProperties": false }, "MultiFactorTypes": { "enum": [ "Sms", "Email", "AuthenticatorApp", "UpParty" ], "type": "string" }, "MultiFactorUpParty": { "required": [ "displayName", "name", "type" ], "type": "object", "properties": { "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "profileName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PartyTypes" } }, "additionalProperties": false }, "MyTenantRequest": { "type": "object", "properties": { "planName": { "maxLength": 30, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "customDomain": { "maxLength": 200, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", "type": "string", "nullable": true }, "customer": { "$ref": "#/components/schemas/Customer" } }, "additionalProperties": false }, "MyUser": { "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "userId": { "maxLength": 40, "type": "string", "nullable": true }, "changePassword": { "type": "boolean" } }, "additionalProperties": false }, "NemLoginAssetsSettings": { "type": "object", "properties": { "metadataProductionOiosaml400Url": { "type": "string", "nullable": true }, "metadataIntegrationTestOiosaml400Url": { "type": "string", "nullable": true }, "metadataProductionOiosaml303Url": { "type": "string", "nullable": true }, "metadataIntegrationTestOiosaml303Url": { "type": "string", "nullable": true }, "testCertificateUrl": { "type": "string", "nullable": true }, "testCertificatePasswordUrl": { "type": "string", "nullable": true } }, "additionalProperties": false }, "NemLoginEnvironments": { "enum": [ "Production", "IntegrationTest" ], "type": "string" }, "NemLoginSectors": { "enum": [ "PublicOiosaml303", "PublicOiosaml400", "PrivateOiosaml303", "PrivateOiosaml400" ], "type": "string" }, "NewPartyName": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "isUpParty": { "type": "boolean" } }, "additionalProperties": false }, "OAuthAdditionalParameter": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w:\\-/.]*$", "type": "string" }, "value": { "maxLength": 250, "minLength": 1, "pattern": "^[\\w\\-/:;.,=\\[\\]\\{\\} \"']*$", "type": "string" } }, "additionalProperties": false }, "OAuthClaimTransform": { "required": [ "action", "type" ], "type": "object", "properties": { "name": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ClaimTransformTypes" }, "order": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "action": { "$ref": "#/components/schemas/ClaimTransformActions" }, "externalConnectType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "secretLoaded": { "maxLength": 300, "type": "string", "nullable": true }, "task": { "$ref": "#/components/schemas/ClaimTransformTasks" }, "error": { "maxLength": 1000, "type": "string", "nullable": true }, "errorMessage": { "maxLength": 1000, "type": "string", "nullable": true }, "upPartyType": { "$ref": "#/components/schemas/PartyTypes" }, "upPartyName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "upPartyProfileName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "claimsIn": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "claimOut": { "maxLength": 100, "pattern": "^[\\w:\\/\\-.+ \\*]*$", "type": "string", "nullable": true, "deprecated": true }, "claimsOut": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "transformation": { "maxLength": 300, "type": "string", "nullable": true }, "transformationExtension": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthClientKeyRequest": { "required": [ "certificate", "partyName" ], "type": "object", "properties": { "partyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "certificate": { "maxLength": 20000, "minLength": 1, "type": "string" }, "password": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthClientKeyResponse": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "primaryKey": { "$ref": "#/components/schemas/ClientKey" } }, "additionalProperties": false }, "OAuthClientSecretRequest": { "required": [ "partyName" ], "type": "object", "properties": { "partyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "secrets": { "maximum": 10, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OAuthClientSecretResponse": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 91, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "info": { "maxLength": 3, "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthClientSecretSingleRequest": { "required": [ "partyName", "secret" ], "type": "object", "properties": { "partyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "secret": { "maxLength": 300, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "OAuthClientSecretSingleResponse": { "type": "object", "properties": { "info": { "maxLength": 3, "type": "string", "nullable": true } }, "additionalProperties": false }, "OAuthDownClaim": { "required": [ "claim" ], "type": "object", "properties": { "claim": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ \\*]*$", "type": "string" }, "values": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OAuthDownClient": { "type": "object", "properties": { "resourceScopes": { "maximum": 50, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownResourceScope" }, "nullable": true }, "scopes": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownScope" }, "nullable": true }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownClaim" }, "nullable": true }, "responseTypes": { "maximum": 5, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUris": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "disableAbsoluteUris": { "type": "boolean" }, "clientAuthenticationMethod": { "$ref": "#/components/schemas/ClientAuthenticationMethods" }, "clientKeys": { "maximum": 4, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "requirePkce": { "type": "boolean" }, "authorizationCodeLifetime": { "maximum": 900, "minimum": 10, "type": "integer", "format": "int32", "nullable": true }, "accessTokenLifetime": { "maximum": 86400, "minimum": 300, "type": "integer", "format": "int32" }, "refreshTokenLifetime": { "maximum": 126144000, "minimum": 900, "type": "integer", "format": "int32", "nullable": true }, "refreshTokenAbsoluteLifetime": { "maximum": 126144000, "minimum": 900, "type": "integer", "format": "int32", "nullable": true }, "refreshTokenUseOneTime": { "type": "boolean", "nullable": true }, "refreshTokenLifetimeUnlimited": { "type": "boolean", "nullable": true }, "disableClientCredentialsGrant": { "type": "boolean" }, "disableTokenExchangeGrant": { "type": "boolean" }, "disableClientAsTokenExchangeActor": { "type": "boolean" } }, "additionalProperties": false }, "OAuthDownParty": { "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "allowUpPartyNames": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "allowUpParties": { "maximum": 200, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "client": { "$ref": "#/components/schemas/OAuthDownClient" }, "resource": { "$ref": "#/components/schemas/OAuthDownResource" }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "allowCorsOrigins": { "maximum": 40, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "usePartyIssuer": { "type": "boolean" } }, "additionalProperties": false }, "OAuthDownResource": { "type": "object", "properties": { "scopes": { "maximum": 100, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OAuthDownResourceScope": { "required": [ "resource" ], "type": "object", "properties": { "resource": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "scopes": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "OAuthDownScope": { "required": [ "scope" ], "type": "object", "properties": { "scope": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w:;.,=\\[\\]\\-_]*$", "type": "string" }, "voluntaryClaims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownClaim" }, "nullable": true } }, "additionalProperties": false }, "OAuthUpClient": { "type": "object", "properties": { "spClientId": { "maxLength": 300, "type": "string", "nullable": true }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "userInfoUrl": { "maxLength": 500, "type": "string", "nullable": true }, "useUserInfoClaims": { "type": "boolean" } }, "additionalProperties": false }, "OAuthUpParty": { "required": [ "authority", "client", "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "oidcDiscoveryUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32", "nullable": true }, "authority": { "maxLength": 300, "minLength": 1, "type": "string" }, "editIssuersInAutomatic": { "type": "boolean", "nullable": true }, "issuers": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "spIssuer": { "maxLength": 300, "type": "string", "nullable": true }, "keys": { "maximum": 50, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "client": { "$ref": "#/components/schemas/OAuthUpClient" }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "disableUserAuthenticationTrust": { "type": "boolean" }, "disableTokenExchangeTrust": { "type": "boolean" } }, "additionalProperties": false }, "OidcDownClaim": { "required": [ "claim" ], "type": "object", "properties": { "claim": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\/\\-.+ \\*]*$", "type": "string" }, "values": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "inIdToken": { "type": "boolean", "nullable": true } }, "additionalProperties": false }, "OidcDownClient": { "type": "object", "properties": { "resourceScopes": { "maximum": 50, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownResourceScope" }, "nullable": true }, "scopes": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OidcDownScope" }, "nullable": true }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OidcDownClaim" }, "nullable": true }, "responseTypes": { "maximum": 5, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "redirectUris": { "maximum": 200, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "disableAbsoluteUris": { "type": "boolean" }, "postLogoutRedirectUri": { "maxLength": 500, "type": "string", "nullable": true }, "frontChannelLogoutUri": { "maxLength": 500, "type": "string", "nullable": true }, "frontChannelLogoutSessionRequired": { "type": "boolean" }, "clientAuthenticationMethod": { "$ref": "#/components/schemas/ClientAuthenticationMethods" }, "clientKeys": { "maximum": 4, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "requirePkce": { "type": "boolean" }, "authorizationCodeLifetime": { "maximum": 900, "minimum": 10, "type": "integer", "format": "int32", "nullable": true }, "accessTokenLifetime": { "maximum": 86400, "minimum": 300, "type": "integer", "format": "int32", "nullable": true }, "refreshTokenLifetime": { "maximum": 126144000, "minimum": 900, "type": "integer", "format": "int32", "nullable": true }, "refreshTokenAbsoluteLifetime": { "maximum": 126144000, "minimum": 900, "type": "integer", "format": "int32", "nullable": true }, "refreshTokenUseOneTime": { "type": "boolean", "nullable": true }, "refreshTokenLifetimeUnlimited": { "type": "boolean", "nullable": true }, "idTokenLifetime": { "maximum": 86400, "minimum": 300, "type": "integer", "format": "int32", "nullable": true }, "requireLogoutIdTokenHint": { "type": "boolean", "nullable": true }, "responseMode": { "maxLength": 30, "type": "string", "nullable": true }, "disableClientCredentialsGrant": { "type": "boolean" }, "disableTokenExchangeGrant": { "type": "boolean" }, "disableClientAsTokenExchangeActor": { "type": "boolean" } }, "additionalProperties": false }, "OidcDownParty": { "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "allowUpPartyNames": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "allowUpParties": { "maximum": 200, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "client": { "$ref": "#/components/schemas/OidcDownClient" }, "resource": { "$ref": "#/components/schemas/OAuthDownResource" }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "allowCorsOrigins": { "maximum": 40, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "usePartyIssuer": { "type": "boolean" }, "isTest": { "type": "boolean", "nullable": true }, "testUrl": { "maxLength": 10240, "type": "string", "nullable": true }, "testExpireAt": { "type": "integer", "format": "int64", "nullable": true }, "testExpireInSeconds": { "type": "integer", "format": "int32", "nullable": true } }, "additionalProperties": false }, "OidcDownScope": { "required": [ "scope" ], "type": "object", "properties": { "scope": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w:;.,=\\[\\]\\-_]*$", "type": "string" }, "voluntaryClaims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OidcDownClaim" }, "nullable": true } }, "additionalProperties": false }, "OidcUpClient": { "type": "object", "properties": { "spClientId": { "maxLength": 300, "type": "string", "nullable": true }, "scopes": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true }, "responseMode": { "maxLength": 30, "type": "string", "nullable": true }, "responseType": { "maxLength": 30, "type": "string", "nullable": true }, "authorizeUrl": { "maxLength": 500, "type": "string", "nullable": true }, "tokenUrl": { "maxLength": 500, "type": "string", "nullable": true }, "userInfoUrl": { "maxLength": 500, "type": "string", "nullable": true }, "endSessionUrl": { "maxLength": 500, "type": "string", "nullable": true }, "disableFrontChannelLogout": { "type": "boolean" }, "frontChannelLogoutSessionRequired": { "type": "boolean" }, "clientAuthenticationMethod": { "$ref": "#/components/schemas/ClientAuthenticationMethods" }, "clientSecret": { "maxLength": 300, "type": "string", "nullable": true }, "enablePkce": { "type": "boolean" }, "useUserInfoClaims": { "type": "boolean" }, "useIdTokenClaims": { "type": "boolean" } }, "additionalProperties": false }, "OidcUpClientProfile": { "type": "object", "properties": { "scopes": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true } }, "additionalProperties": false }, "OidcUpParty": { "required": [ "authority", "client", "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "oidcDiscoveryUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32", "nullable": true }, "authority": { "maxLength": 300, "minLength": 1, "type": "string" }, "editIssuersInAutomatic": { "type": "boolean", "nullable": true }, "issuers": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "spIssuer": { "maxLength": 300, "type": "string", "nullable": true }, "keys": { "maximum": 50, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "client": { "$ref": "#/components/schemas/OidcUpClient" }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "externalUserLoadedClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true, "deprecated": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "disableUserAuthenticationTrust": { "type": "boolean" }, "disableTokenExchangeTrust": { "type": "boolean" }, "linkExternalUser": { "$ref": "#/components/schemas/LinkExternalUser" }, "profiles": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OidcUpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "OidcUpPartyProfile": { "required": [ "client", "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "newName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "client": { "$ref": "#/components/schemas/OidcUpClientProfile" } }, "additionalProperties": false }, "PartyBindingPatterns": { "enum": [ "Brackets", "Tildes", "Dot" ], "type": "string" }, "PartyNameSessionLink": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "type": { "$ref": "#/components/schemas/PartyTypes" } }, "additionalProperties": false }, "PartyTypes": { "enum": [ "Login", "OAuth2", "Oidc", "Saml2", "WsFed", "TrackLink", "ExternalLogin" ], "type": "string", "nullable": true }, "PartyUpdateStates": { "enum": [ "Manual", "Automatic", "AutomaticStopped" ], "type": "string" }, "PasswordHistoryItem": { "required": [ "hash", "hashAlgorithm" ], "type": "object", "properties": { "hashAlgorithm": { "maxLength": 20, "minLength": 1, "type": "string" }, "hash": { "maxLength": 2048, "minLength": 1, "type": "string" }, "hashSalt": { "maxLength": 512, "type": "string", "nullable": true }, "created": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "PasswordPolicy": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 10, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "displayName": { "maxLength": 30, "pattern": "^[\\w;:\\/\\-.,+ ]*$", "type": "string", "nullable": true }, "length": { "maximum": 50, "minimum": 4, "type": "integer", "format": "int32" }, "maxLength": { "maximum": 50, "minimum": 4, "type": "integer", "format": "int32" }, "checkComplexity": { "type": "boolean" }, "checkRisk": { "type": "boolean" }, "bannedCharacters": { "maxLength": 20, "type": "string", "nullable": true }, "history": { "maximum": 30, "minimum": 0, "type": "integer", "format": "int32" }, "maxAge": { "maximum": 63072000, "minimum": 0, "type": "integer", "format": "int64" }, "softChange": { "maximum": 2592000, "minimum": 0, "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Payment": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "cardHolder": { "type": "string", "nullable": true }, "cardNumberInfo": { "maxLength": 10, "type": "string", "nullable": true }, "cardLabel": { "maxLength": 100, "type": "string", "nullable": true }, "cardExpiryMonth": { "type": "integer", "format": "int32" }, "cardExpiryYear": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Plan": { "required": [ "costPerMonth", "emails", "logins", "name", "sms", "tokenRequests", "tracks", "upParties", "users" ], "type": "object", "properties": { "name": { "maxLength": 30, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "displayName": { "maxLength": 50, "pattern": "^[\\w;:\\/\\-.,+ ]*$", "type": "string", "nullable": true }, "text": { "maxLength": 4000, "type": "string", "nullable": true }, "costPerMonth": { "type": "number", "format": "double" }, "enableCustomDomain": { "type": "boolean" }, "enableSms": { "type": "boolean" }, "enableEmailTwoFactor": { "type": "boolean" }, "tracks": { "$ref": "#/components/schemas/PlanItem" }, "upParties": { "$ref": "#/components/schemas/PlanItem" }, "users": { "$ref": "#/components/schemas/PlanItem" }, "logins": { "$ref": "#/components/schemas/PlanItem" }, "tokenRequests": { "$ref": "#/components/schemas/PlanItem" }, "sms": { "$ref": "#/components/schemas/PlanItem" }, "emails": { "$ref": "#/components/schemas/PlanItem" }, "logLifetime": { "$ref": "#/components/schemas/LogLifetimeOptions" } }, "additionalProperties": false }, "PlanInfo": { "type": "object", "properties": { "name": { "type": "string", "nullable": true }, "displayName": { "type": "string", "nullable": true }, "costPerMonth": { "type": "number", "format": "double" } }, "additionalProperties": false }, "PlanItem": { "required": [ "firstLevelCost", "included" ], "type": "object", "properties": { "included": { "type": "integer", "format": "int64" }, "limitedThreshold": { "type": "integer", "format": "int64", "nullable": true }, "firstLevelCost": { "type": "number", "format": "double" }, "firstLevelThreshold": { "type": "integer", "format": "int64", "nullable": true }, "secondLevelCost": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "PlanPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Plan" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "RefreshTokenGrant": { "required": [ "createTime" ], "type": "object", "properties": { "refreshToken": { "maxLength": 100, "pattern": "^[\\w-_]*$", "type": "string", "nullable": true }, "clientId": { "maxLength": 50, "type": "string", "nullable": true }, "sessionId": { "maxLength": 200, "type": "string", "nullable": true }, "sub": { "maxLength": 10000, "type": "string", "nullable": true }, "email": { "maxLength": 10000, "type": "string", "nullable": true }, "phone": { "maxLength": 10000, "type": "string", "nullable": true }, "username": { "maxLength": 10000, "type": "string", "nullable": true }, "upPartyName": { "maxLength": 10000, "type": "string", "nullable": true }, "upPartyType": { "maxLength": 10000, "type": "string", "nullable": true }, "createTime": { "type": "integer", "format": "int64" }, "timeToLive": { "type": "integer", "format": "int32", "nullable": true }, "claims": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true } }, "additionalProperties": false }, "RefreshTokenGrantPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/RefreshTokenGrant" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceCultureItem": { "required": [ "culture" ], "type": "object", "properties": { "culture": { "maxLength": 5, "minLength": 1, "type": "string" }, "defaultValue": { "maxLength": 500, "type": "string", "nullable": true }, "value": { "maxLength": 500, "type": "string", "nullable": true } }, "additionalProperties": false }, "ResourceItem": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "items": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/ResourceCultureItem" }, "nullable": true } }, "additionalProperties": false }, "ResourceName": { "required": [ "id", "name" ], "type": "object", "properties": { "name": { "maxLength": 500, "minLength": 1, "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceNamePaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/ResourceName" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "ResourceSettings": { "type": "object", "properties": { "showResourceId": { "type": "boolean" } }, "additionalProperties": false }, "RiskPassword": { "required": [ "count", "passwordSha1Hash" ], "type": "object", "properties": { "passwordSha1Hash": { "maxLength": 40, "minLength": 1, "pattern": "^[A-F0-9]*$", "type": "string" }, "count": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "RiskPasswordDelete": { "type": "object", "properties": { "passwordSha1Hashs": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "RiskPasswordInfo": { "type": "object", "properties": { "riskPasswordCount": { "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "RiskPasswordRequest": { "type": "object", "properties": { "riskPasswords": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/RiskPassword" }, "nullable": true } }, "additionalProperties": false }, "Saml2AuthnResponseSignTypes": { "enum": [ "SignResponse", "SignAssertion", "SignAssertionAndResponse" ], "type": "string" }, "SamlAuthnContextComparisonTypes": { "enum": [ "Exact", "Minimum", "Maximum", "Better" ], "type": "string" }, "SamlBindingTypes": { "enum": [ "Redirect", "Post" ], "type": "string" }, "SamlClaimTransform": { "required": [ "action", "type" ], "type": "object", "properties": { "name": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/ClaimTransformTypes" }, "order": { "maximum": 1000, "minimum": 0, "type": "integer", "format": "int32" }, "action": { "$ref": "#/components/schemas/ClaimTransformActions" }, "externalConnectType": { "$ref": "#/components/schemas/ExternalConnectTypes" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "secret": { "maxLength": 300, "type": "string", "nullable": true }, "secretLoaded": { "maxLength": 300, "type": "string", "nullable": true }, "task": { "$ref": "#/components/schemas/ClaimTransformTasks" }, "error": { "maxLength": 1000, "type": "string", "nullable": true }, "errorMessage": { "maxLength": 1000, "type": "string", "nullable": true }, "upPartyType": { "$ref": "#/components/schemas/PartyTypes" }, "upPartyName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "upPartyProfileName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "claimsIn": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "claimOut": { "maxLength": 300, "pattern": "^[\\w:\\/\\-.+ \\*]*$", "type": "string", "nullable": true, "deprecated": true }, "claimsOut": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "transformation": { "maxLength": 300, "type": "string", "nullable": true }, "transformationExtension": { "maxLength": 300, "type": "string", "nullable": true } }, "additionalProperties": false }, "SamlDownParty": { "required": [ "authnRequestBinding", "authnResponseBinding", "certificateValidationMode", "revocationMode", "signatureAlgorithm", "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "metadataUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32", "nullable": true }, "metadataUrl": { "maxLength": 500, "type": "string", "nullable": true }, "allowUpPartyNames": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "allowUpParties": { "maximum": 200, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "idPIssuer": { "maxLength": 300, "type": "string", "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlClaimTransform" }, "nullable": true }, "claims": { "maximum": 500, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "subjectConfirmationLifetime": { "maximum": 900, "minimum": 60, "type": "integer", "format": "int32", "nullable": true }, "issuedTokenLifetime": { "maximum": 86400, "minimum": 300, "type": "integer", "format": "int32", "nullable": true }, "signatureAlgorithm": { "maxLength": 100, "minLength": 1, "type": "string" }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "certificateValidationMode": { "$ref": "#/components/schemas/X509CertificateValidationMode" }, "revocationMode": { "$ref": "#/components/schemas/X509RevocationMode" }, "authnResponseSignType": { "$ref": "#/components/schemas/Saml2AuthnResponseSignTypes" }, "issuer": { "maxLength": 300, "type": "string", "nullable": true }, "authnRequestBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "authnResponseBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "acsUrls": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "disableAbsoluteUrls": { "type": "boolean" }, "encryptAuthnResponse": { "type": "boolean" }, "nameIdFormat": { "type": "string", "nullable": true }, "logoutRequestBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "logoutResponseBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "singleLogoutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "loggedOutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "keys": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "encryptionKey": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "metadataAddLogoutResponseLocation": { "type": "boolean" }, "signMetadata": { "type": "boolean" }, "metadataIncludeEncryptionCertificates": { "type": "boolean" }, "metadataNameIdFormats": { "maximum": 5, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "metadataOrganization": { "$ref": "#/components/schemas/SamlMetadataOrganization" }, "metadataContactPersons": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlMetadataContactPerson" }, "nullable": true } }, "additionalProperties": false }, "SamlMetadataAttributeConsumingService": { "required": [ "serviceName" ], "type": "object", "properties": { "serviceName": { "$ref": "#/components/schemas/SamlMetadataServiceName" }, "requestedAttributes": { "maximum": 100, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/SamlMetadataRequestedAttribute" }, "nullable": true } }, "additionalProperties": false }, "SamlMetadataContactPerson": { "required": [ "contactType" ], "type": "object", "properties": { "contactType": { "$ref": "#/components/schemas/SamlMetadataContactPersonTypes" }, "company": { "maxLength": 1000, "type": "string", "nullable": true }, "givenName": { "maxLength": 1000, "type": "string", "nullable": true }, "surname": { "maxLength": 1000, "type": "string", "nullable": true }, "emailAddress": { "maxLength": 1000, "type": "string", "nullable": true }, "telephoneNumber": { "maxLength": 1000, "type": "string", "nullable": true } }, "additionalProperties": false }, "SamlMetadataContactPersonTypes": { "enum": [ "Technical", "Support", "Administrative", "Billing", "Other" ], "type": "string" }, "SamlMetadataOrganization": { "required": [ "organizationDisplayName", "organizationName", "organizationUrl" ], "type": "object", "properties": { "organizationName": { "maxLength": 1000, "minLength": 1, "type": "string" }, "organizationDisplayName": { "maxLength": 1000, "minLength": 1, "type": "string" }, "organizationUrl": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SamlMetadataRequestedAttribute": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 1000, "minLength": 1, "type": "string" }, "isRequired": { "type": "boolean" }, "nameFormat": { "maxLength": 1000, "type": "string", "nullable": true } }, "additionalProperties": false }, "SamlMetadataServiceName": { "required": [ "lang", "name" ], "type": "object", "properties": { "lang": { "maxLength": 10, "minLength": 1, "type": "string" }, "name": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SamlReadMetadataRequest": { "required": [ "metadata", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SamlReadMetadataType" }, "metadata": { "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SamlReadMetadataType": { "enum": [ "Url", "Xml" ], "type": "string" }, "SamlUpParty": { "required": [ "authnResponseBinding", "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "moduleType": { "$ref": "#/components/schemas/UpPartyModuleTypes" }, "modules": { "$ref": "#/components/schemas/SamlUpPartyModules" }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "metadataUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32", "nullable": true }, "metadataUrl": { "maxLength": 500, "type": "string", "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "externalUserLoadedClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true, "deprecated": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "claims": { "maximum": 500, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "xmlCanonicalizationMethod": { "maxLength": 100, "type": "string", "nullable": true }, "signatureAlgorithm": { "maxLength": 100, "type": "string", "nullable": true }, "certificateValidationMode": { "$ref": "#/components/schemas/X509CertificateValidationMode" }, "revocationMode": { "$ref": "#/components/schemas/X509RevocationMode" }, "issuer": { "maxLength": 300, "type": "string", "nullable": true }, "spIssuer": { "maxLength": 300, "type": "string", "nullable": true }, "authnRequestBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "authnResponseBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "authnUrl": { "maxLength": 500, "type": "string", "nullable": true }, "signAuthnRequest": { "type": "boolean" }, "keys": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "logoutRequestBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "logoutResponseBinding": { "$ref": "#/components/schemas/SamlBindingTypes" }, "logoutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "singleLogoutResponseUrl": { "maxLength": 500, "type": "string", "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "authnContextComparison": { "$ref": "#/components/schemas/SamlAuthnContextComparisonTypes" }, "authnContextClassReferences": { "type": "array", "items": { "type": "string" }, "nullable": true }, "authnRequestExtensionsXml": { "type": "string", "nullable": true }, "disableLoginHint": { "type": "boolean" }, "metadataAddLogoutResponseLocation": { "type": "boolean" }, "signMetadata": { "type": "boolean" }, "metadataIncludeEncryptionCertificates": { "type": "boolean" }, "metadataNameIdFormats": { "maximum": 5, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "metadataAttributeConsumingServices": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlMetadataAttributeConsumingService" }, "nullable": true }, "metadataOrganization": { "$ref": "#/components/schemas/SamlMetadataOrganization" }, "metadataContactPersons": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlMetadataContactPerson" }, "nullable": true }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "disableUserAuthenticationTrust": { "type": "boolean" }, "disableTokenExchangeTrust": { "type": "boolean" }, "enableIdPInitiated": { "type": "boolean" }, "idPInitiatedGrantLifetime": { "maximum": 300, "minimum": 5, "type": "integer", "format": "int32", "nullable": true }, "linkExternalUser": { "$ref": "#/components/schemas/LinkExternalUser" }, "profiles": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlUpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "SamlUpPartyModules": { "type": "object", "properties": { "showStandardSettings": { "type": "boolean" }, "nemLogin": { "$ref": "#/components/schemas/SamlUpPartyNemLoginModule" } }, "additionalProperties": false }, "SamlUpPartyNemLoginModule": { "required": [ "environment", "sector" ], "type": "object", "properties": { "environment": { "$ref": "#/components/schemas/NemLoginEnvironments" }, "sector": { "$ref": "#/components/schemas/NemLoginSectors" }, "requestCpr": { "type": "boolean" }, "saveCprOnExternalUsers": { "type": "boolean" } }, "additionalProperties": false }, "SamlUpPartyProfile": { "required": [ "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "newName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "authnContextComparison": { "$ref": "#/components/schemas/SamlAuthnContextComparisonTypes" }, "authnContextClassReferences": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "authnRequestExtensionsXml": { "maxLength": 1000, "type": "string", "nullable": true } }, "additionalProperties": false }, "SendEmail": { "required": [ "fromEmail" ], "type": "object", "properties": { "fromEmail": { "maxLength": 60, "minLength": 1, "pattern": "^[\\w:\\-.+@]*$", "type": "string" }, "fromName": { "maxLength": 100, "type": "string", "nullable": true }, "sendgridApiKey": { "maxLength": 200, "type": "string", "nullable": true }, "smtpHost": { "maxLength": 100, "type": "string", "nullable": true }, "smtpPort": { "type": "integer", "format": "int32" }, "smtpUsername": { "maxLength": 100, "type": "string", "nullable": true }, "smtpPassword": { "maxLength": 200, "type": "string", "nullable": true } }, "additionalProperties": false }, "SendSms": { "required": [ "fromName", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/SendSmsTypes" }, "fromName": { "maxLength": 100, "minLength": 1, "type": "string" }, "apiUrl": { "maxLength": 500, "type": "string", "nullable": true }, "clientId": { "maxLength": 300, "type": "string", "nullable": true }, "clientSecret": { "maxLength": 300, "type": "string", "nullable": true }, "label": { "maxLength": 100, "type": "string", "nullable": true }, "key": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "parameters": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SendSmsAccessUrlParameter" }, "nullable": true } }, "additionalProperties": false }, "SendSmsAccessUrlParameter": { "required": [ "name", "value" ], "type": "object", "properties": { "name": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w:\\-/.]*$", "type": "string" }, "value": { "maxLength": 1000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "SendSmsTypes": { "enum": [ "AccessUrl", "GatewayApi", "Smstools", "TeliaSmsGateway" ], "type": "string" }, "SmsPrice": { "required": [ "iso2", "phoneCode", "price" ], "type": "object", "properties": { "countryName": { "maxLength": 200, "type": "string", "nullable": true }, "iso2": { "maxLength": 2, "minLength": 1, "type": "string" }, "phoneCode": { "type": "integer", "format": "int32" }, "price": { "type": "number", "format": "double" } }, "additionalProperties": false }, "SmsPricePaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/SmsPrice" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "Tenant": { "required": [ "name" ], "type": "object", "properties": { "planName": { "maxLength": 30, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "customDomain": { "maxLength": 200, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "pattern": "^\\w[\\w\\-]*$", "type": "string" }, "customDomainVerified": { "type": "boolean" }, "forUsage": { "type": "boolean" }, "enableUsage": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "maxLength": 3, "type": "string", "nullable": true }, "includeVat": { "type": "boolean" }, "hourPrice": { "type": "number", "format": "double", "nullable": true } }, "additionalProperties": false }, "TenantPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Tenant" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TenantRequest": { "required": [ "name" ], "type": "object", "properties": { "planName": { "maxLength": 30, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "customDomain": { "maxLength": 200, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "pattern": "^\\w[\\w\\-]*$", "type": "string" }, "customDomainVerified": { "type": "boolean" }, "forUsage": { "type": "boolean" }, "enableUsage": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "maxLength": 3, "type": "string", "nullable": true }, "includeVat": { "type": "boolean" }, "hourPrice": { "type": "number", "format": "double", "nullable": true }, "customer": { "$ref": "#/components/schemas/Customer" } }, "additionalProperties": false }, "TenantResponse": { "required": [ "name" ], "type": "object", "properties": { "planName": { "maxLength": 30, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "customDomain": { "maxLength": 200, "pattern": "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$", "type": "string", "nullable": true }, "name": { "maxLength": 50, "minLength": 1, "pattern": "^\\w[\\w\\-]*$", "type": "string" }, "customDomainVerified": { "type": "boolean" }, "forUsage": { "type": "boolean" }, "enableUsage": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "maxLength": 3, "type": "string", "nullable": true }, "includeVat": { "type": "boolean" }, "hourPrice": { "type": "number", "format": "double", "nullable": true }, "customer": { "$ref": "#/components/schemas/Customer" }, "payment": { "$ref": "#/components/schemas/Payment" } }, "additionalProperties": false }, "Track": { "required": [ "checkPasswordComplexity", "checkPasswordRisk" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+ ]*$", "type": "string", "nullable": true }, "companyName": { "maxLength": 60, "type": "string", "nullable": true }, "addressLine1": { "maxLength": 50, "type": "string", "nullable": true }, "addressLine2": { "maxLength": 50, "type": "string", "nullable": true }, "postalCode": { "maxLength": 50, "type": "string", "nullable": true }, "city": { "maxLength": 50, "type": "string", "nullable": true }, "stateRegion": { "maxLength": 50, "type": "string", "nullable": true }, "country": { "maxLength": 50, "type": "string", "nullable": true }, "sequenceLifetime": { "maximum": 18000, "minimum": 30, "type": "integer", "format": "int32" }, "autoMapSamlClaims": { "type": "boolean" }, "maxFailingLogins": { "maximum": 20, "minimum": 2, "type": "integer", "format": "int32" }, "failingLoginCountLifetime": { "maximum": 345600, "minimum": 900, "type": "integer", "format": "int32" }, "failingLoginObservationPeriod": { "maximum": 14400, "minimum": 60, "type": "integer", "format": "int32" }, "passwordLength": { "maximum": 50, "minimum": 4, "type": "integer", "format": "int32" }, "passwordMaxLength": { "maximum": 50, "minimum": 4, "type": "integer", "format": "int32" }, "checkPasswordComplexity": { "type": "boolean" }, "checkPasswordRisk": { "type": "boolean" }, "passwordBannedCharacters": { "maxLength": 20, "type": "string", "nullable": true }, "passwordHistory": { "maximum": 30, "minimum": 0, "type": "integer", "format": "int32" }, "passwordMaxAge": { "maximum": 63072000, "minimum": 0, "type": "integer", "format": "int64" }, "softPasswordChange": { "maximum": 2592000, "minimum": 0, "type": "integer", "format": "int64" }, "passwordPolicies": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/PasswordPolicy" }, "nullable": true }, "externalPassword": { "$ref": "#/components/schemas/ExternalPassword" }, "directoryConnector": { "$ref": "#/components/schemas/DirectoryConnector" }, "allowIframeOnDomains": { "maximum": 40, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TrackKey": { "required": [ "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/TrackKeyTypes" } }, "additionalProperties": false }, "TrackKeyItemContainedRequest": { "type": "object", "properties": { "isPrimary": { "type": "boolean" }, "createSelfSigned": { "type": "boolean" }, "key": { "$ref": "#/components/schemas/JsonWebKey" } }, "additionalProperties": false }, "TrackKeyItemContainedSwap": { "type": "object", "properties": { "swapKeys": { "type": "boolean" } }, "additionalProperties": false }, "TrackKeyItemsContained": { "required": [ "name", "primaryKey" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "primaryKey": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "secondaryKey": { "$ref": "#/components/schemas/JwkWithCertificateInfo" } }, "additionalProperties": false }, "TrackKeyTypes": { "enum": [ "Contained", "KeyVaultRenewSelfSigned", "ContainedRenewSelfSigned" ], "type": "string" }, "TrackLargeResourceCultureItem": { "required": [ "culture" ], "type": "object", "properties": { "culture": { "maxLength": 5, "minLength": 1, "type": "string" }, "value": { "maxLength": 40000, "type": "string", "nullable": true } }, "additionalProperties": false }, "TrackLargeResourceItem": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 40, "minLength": 10, "type": "string" }, "items": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/TrackLargeResourceCultureItem" }, "nullable": true } }, "additionalProperties": false }, "TrackLargeResourceItemPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/TrackLargeResourceItem" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TrackLinkDownParty": { "required": [ "toUpPartyName", "toUpTrackName" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "allowUpPartyNames": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "allowUpParties": { "maximum": 200, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "toUpTrackName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_-]*$", "type": "string" }, "toUpPartyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthDownClaim" }, "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true } }, "additionalProperties": false }, "TrackLinkUpParty": { "required": [ "toDownPartyName", "toDownTrackName" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "toDownTrackName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_-]*$", "type": "string" }, "toDownPartyName": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "selectedUpParties": { "maximum": 4, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "pipeExternalId": { "type": "boolean" }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "externalUserLoadedClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true, "deprecated": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "linkExternalUser": { "$ref": "#/components/schemas/LinkExternalUser" }, "profiles": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/TrackLinkUpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "TrackLinkUpPartyProfile": { "required": [ "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "newName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "selectedUpParties": { "maximum": 4, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "TrackPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/Track" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "TrackResourceItem": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "items": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/ResourceCultureItem" }, "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "TrackResourceName": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 500, "minLength": 1, "type": "string" }, "id": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpParty": { "required": [ "name", "type" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "type": { "$ref": "#/components/schemas/PartyTypes" }, "moduleType": { "$ref": "#/components/schemas/UpPartyModuleTypes" }, "profiles": { "type": "array", "items": { "$ref": "#/components/schemas/UpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "UpPartyLink": { "required": [ "name" ], "type": "object", "properties": { "name": { "maxLength": 50, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "profileName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true } }, "additionalProperties": false }, "UpPartyModuleTypes": { "enum": [ "NemLogin", "MicrosoftEntraId" ], "type": "string" }, "UpPartyPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UpParty" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UpPartyProfile": { "required": [ "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" } }, "additionalProperties": false }, "UpdateUsageRequest": { "required": [ "periodBeginDate", "tenantName" ], "type": "object", "properties": { "tenantName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_][a-z0-9_-]*$", "type": "string" }, "periodBeginDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date", "nullable": true }, "items": { "maximum": 1000, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsedItem" }, "nullable": true } }, "additionalProperties": false }, "UsageCurrencyExchange": { "required": [ "currency", "rate" ], "type": "object", "properties": { "currency": { "maxLength": 3, "minLength": 1, "type": "string" }, "rate": { "type": "number", "format": "double" } }, "additionalProperties": false }, "UsageInvoiceSendStatus": { "enum": [ "None", "Send", "Failed" ], "type": "string" }, "UsageInvoicingAction": { "required": [ "periodBeginDate", "tenantName" ], "type": "object", "properties": { "tenantName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_][a-z0-9_-]*$", "type": "string" }, "periodBeginDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date", "nullable": true }, "doInvoicing": { "type": "boolean" }, "doSendInvoiceAgain": { "type": "boolean" }, "doCreditNote": { "type": "boolean" }, "doSendCreditNoteAgain": { "type": "boolean" }, "doPaymentAgain": { "type": "boolean" }, "markAsPaid": { "type": "boolean" }, "markAsNotPaid": { "type": "boolean" } }, "additionalProperties": false }, "UsageLogItem": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/UsageLogTypes" }, "value": { "type": "number", "format": "double" }, "subItems": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLogItem" }, "nullable": true } }, "additionalProperties": false }, "UsageLogResponse": { "required": [ "summarizeLevel" ], "type": "object", "properties": { "summarizeLevel": { "$ref": "#/components/schemas/UsageLogSummarizeLevels" }, "items": { "type": "array", "items": { "$ref": "#/components/schemas/UsageLogItem" }, "nullable": true } }, "additionalProperties": false }, "UsageLogSummarizeLevels": { "enum": [ "Hour", "Day", "Month" ], "type": "string" }, "UsageLogTimeScopes": { "enum": [ "ThisMonth", "LastMonth", "TwoMonthsAgo", "ThreeMonthsAgo", "FourMonthsAgo", "FiveMonthsAgo" ], "type": "string" }, "UsageLogTypes": { "enum": [ "Hour", "Day", "Tenant", "Track", "UpParty", "User", "Login", "TokenRequest", "ControlApiGet", "ControlApiUpdate", "Passwordless", "Confirmation", "SetPassword", "ResetPassword", "Mfa", "RealCount", "ExtraCount", "Sms", "SmsPrice", "Email" ], "type": "string" }, "UsagePaymentStatus": { "enum": [ "None", "Open", "Pending", "Authorized", "Paid", "Canceled", "Expired", "Failed" ], "type": "string" }, "UsageSettings": { "type": "object", "properties": { "currencyExchanges": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsageCurrencyExchange" }, "nullable": true }, "invoiceNumber": { "type": "integer", "format": "int32" }, "invoiceNumberPrefix": { "maxLength": 20, "pattern": "^[\\w;:\\/\\-.,+ ]*$", "type": "string", "nullable": true }, "hourPrice": { "type": "number", "format": "double" } }, "additionalProperties": false }, "Used": { "required": [ "periodBeginDate", "periodEndDate", "tenantName" ], "type": "object", "properties": { "tenantName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_][a-z0-9_-]*$", "type": "string" }, "periodBeginDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date" }, "isUsageCalculated": { "type": "boolean" }, "isInvoiceReady": { "type": "boolean" }, "paymentStatus": { "$ref": "#/components/schemas/UsagePaymentStatus" }, "isInactive": { "type": "boolean" }, "isDone": { "type": "boolean" }, "hasItems": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "type": "string", "nullable": true }, "invoices": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/Invoice" }, "nullable": true }, "tracks": { "type": "number", "format": "double" }, "upParties": { "type": "number", "format": "double" }, "users": { "type": "number", "format": "double" }, "logins": { "type": "number", "format": "double" }, "tokenRequests": { "type": "number", "format": "double" }, "sms": { "type": "number", "format": "double" }, "smsPrice": { "type": "number", "format": "double" }, "emails": { "type": "number", "format": "double" }, "controlApiGets": { "type": "number", "format": "double" }, "controlApiUpdates": { "type": "number", "format": "double" }, "items": { "maximum": 1000, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UsedItem" }, "nullable": true }, "name": { "type": "string", "nullable": true } }, "additionalProperties": false }, "UsedBase": { "required": [ "periodBeginDate", "periodEndDate", "tenantName" ], "type": "object", "properties": { "tenantName": { "maxLength": 50, "minLength": 1, "pattern": "^[a-z0-9_][a-z0-9_-]*$", "type": "string" }, "periodBeginDate": { "type": "string", "format": "date" }, "periodEndDate": { "type": "string", "format": "date" }, "isUsageCalculated": { "type": "boolean" }, "isInvoiceReady": { "type": "boolean" }, "paymentStatus": { "$ref": "#/components/schemas/UsagePaymentStatus" }, "isInactive": { "type": "boolean" }, "isDone": { "type": "boolean" }, "hasItems": { "type": "boolean" }, "doPayment": { "type": "boolean" }, "currency": { "type": "string", "nullable": true }, "invoices": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/Invoice" }, "nullable": true } }, "additionalProperties": false }, "UsedBasePaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/UsedBase" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UsedItem": { "type": "object", "properties": { "text": { "maxLength": 200, "type": "string", "nullable": true }, "day": { "maximum": 31, "minimum": 0, "type": "integer", "format": "int32", "nullable": true }, "quantity": { "type": "number", "format": "double" }, "unitPrice": { "type": "number", "format": "double" }, "type": { "$ref": "#/components/schemas/UsedItemTypes" } }, "additionalProperties": false }, "UsedItemTypes": { "enum": [ "Text", "Hours" ], "type": "string" }, "User": { "required": [ "userId" ], "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "directoryUserId": { "maxLength": 50, "pattern": "^[\\p{L}0-9:\\-_.+@/=]*$", "type": "string", "nullable": true }, "confirmAccount": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" }, "changePassword": { "type": "boolean" }, "disableSetPasswordSms": { "type": "boolean" }, "disableSetPasswordEmail": { "type": "boolean" }, "setPasswordEmail": { "type": "boolean" }, "setPasswordSms": { "type": "boolean" }, "passwordPolicyName": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "disableAccount": { "type": "boolean" }, "disableTwoFactorApp": { "type": "boolean" }, "disableTwoFactorSms": { "type": "boolean" }, "disableTwoFactorEmail": { "type": "boolean" }, "requireMultiFactor": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "userId": { "maxLength": 40, "minLength": 1, "type": "string" }, "hasPassword": { "type": "boolean" }, "activeTwoFactorApp": { "type": "boolean" }, "passwordLastChanged": { "type": "integer", "format": "int64" }, "softPasswordChangeStarted": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UserChangePasswordRequest": { "required": [ "currentPassword", "newPassword" ], "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "currentPassword": { "maxLength": 50, "minLength": 1, "type": "string", "format": "password" }, "newPassword": { "maxLength": 50, "minLength": 1, "type": "string", "format": "password" } }, "additionalProperties": false }, "UserControlProfile": { "type": "object", "properties": { "lastTrackName": { "maxLength": 50, "pattern": "^[a-z0-9_-]*$", "type": "string", "nullable": true } }, "additionalProperties": false }, "UserPaginationResponse": { "type": "object", "properties": { "data": { "uniqueItems": true, "type": "array", "items": { "$ref": "#/components/schemas/User" }, "nullable": true }, "paginationToken": { "type": "string", "nullable": true }, "limit": { "type": "integer", "format": "int32" } }, "additionalProperties": false }, "UserPasswordHistory": { "required": [ "userId" ], "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "passwordHistory": { "maximum": 30, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/PasswordHistoryItem" }, "nullable": true }, "userId": { "minLength": 1, "type": "string" }, "passwordLastChanged": { "type": "integer", "format": "int64" } }, "additionalProperties": false }, "UserPasswordHistoryRequest": { "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "passwordHistory": { "maximum": 30, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/PasswordHistoryItem" }, "nullable": true } }, "additionalProperties": false }, "UserRequest": { "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "directoryUserId": { "maxLength": 50, "pattern": "^[\\p{L}0-9:\\-_.+@/=]*$", "type": "string", "nullable": true }, "confirmAccount": { "type": "boolean" }, "emailVerified": { "type": "boolean" }, "phoneVerified": { "type": "boolean" }, "changePassword": { "type": "boolean" }, "disableSetPasswordSms": { "type": "boolean" }, "disableSetPasswordEmail": { "type": "boolean" }, "setPasswordEmail": { "type": "boolean" }, "setPasswordSms": { "type": "boolean" }, "passwordPolicyName": { "maxLength": 10, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "disableAccount": { "type": "boolean" }, "disableTwoFactorApp": { "type": "boolean" }, "disableTwoFactorSms": { "type": "boolean" }, "disableTwoFactorEmail": { "type": "boolean" }, "requireMultiFactor": { "type": "boolean" }, "claims": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ClaimAndValues" }, "nullable": true }, "updateEmail": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "updatePhone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "updateUsername": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "activeTwoFactorApp": { "type": "boolean" } }, "additionalProperties": false }, "UserSetPasswordRequest": { "type": "object", "properties": { "email": { "maxLength": 60, "pattern": "^[\\w:\\-.+@]*$", "type": "string", "format": "email", "nullable": true }, "phone": { "maxLength": 30, "pattern": "^\\+[1-9]{1}[0-9]{1,14}$", "type": "string", "nullable": true }, "username": { "maxLength": 60, "pattern": "^[\\p{L}0-9:\\-_.+@]*$", "type": "string", "nullable": true }, "password": { "maxLength": 50, "type": "string", "format": "password", "nullable": true }, "passwordHashAlgorithm": { "maxLength": 20, "type": "string", "nullable": true }, "passwordHash": { "maxLength": 2048, "type": "string", "nullable": true }, "passwordHashSalt": { "maxLength": 512, "type": "string", "nullable": true }, "changePassword": { "type": "boolean" }, "passwordLastChanged": { "maximum": 9.223372036854776E+18, "minimum": 0, "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "UserTypes": { "enum": [ "InternalUser", "ExternalUser" ], "type": "string" }, "UsersDelete": { "type": "object", "properties": { "userIdentifiers": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "type": "string" }, "nullable": true } }, "additionalProperties": false }, "UsersRequest": { "type": "object", "properties": { "users": { "maximum": 1000, "minimum": 1, "type": "array", "items": { "$ref": "#/components/schemas/CreateUserRequest" }, "nullable": true } }, "additionalProperties": false }, "WsFedDownParty": { "required": [ "signatureAlgorithm", "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "metadataUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32" }, "metadataUrl": { "maxLength": 500, "type": "string", "nullable": true }, "allowUpPartyNames": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true, "deprecated": true }, "allowUpParties": { "maximum": 200, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/UpPartyLink" }, "nullable": true }, "idPIssuer": { "maxLength": 300, "type": "string", "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlClaimTransform" }, "nullable": true }, "claims": { "maximum": 500, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "issuedTokenLifetime": { "maximum": 86400, "minimum": 300, "type": "integer", "format": "int32", "nullable": true }, "tokenType": { "$ref": "#/components/schemas/WsFedTokenTypes" }, "signatureAlgorithm": { "maxLength": 100, "minLength": 1, "type": "string" }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "realm": { "maxLength": 300, "type": "string", "nullable": true }, "replyUrls": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "disableAbsoluteUrls": { "type": "boolean" }, "signOutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "loggedOutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "keys": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true } }, "additionalProperties": false }, "WsFedReadMetadataRequest": { "required": [ "metadata", "type" ], "type": "object", "properties": { "type": { "$ref": "#/components/schemas/WsFedReadMetadataType" }, "metadata": { "maxLength": 200000, "minLength": 1, "type": "string" } }, "additionalProperties": false }, "WsFedReadMetadataType": { "enum": [ "Url", "Xml" ], "type": "string" }, "WsFedTokenTypes": { "enum": [ "Saml11", "Saml20" ], "type": "string" }, "WsFedUpParty": { "required": [ "updateState" ], "type": "object", "properties": { "name": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "newName": { "maxLength": 50, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string", "nullable": true }, "note": { "maxLength": 200, "type": "string", "nullable": true }, "updateState": { "$ref": "#/components/schemas/PartyUpdateStates" }, "metadataUpdateRate": { "maximum": 5184000, "minimum": 14400, "type": "integer", "format": "int32" }, "metadataUrl": { "maxLength": 500, "type": "string", "nullable": true }, "claimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/SamlClaimTransform" }, "nullable": true }, "extendedUis": { "maximum": 5, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/ExtendedUi" }, "nullable": true }, "externalUserLoadedClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true, "deprecated": true }, "exitClaimTransforms": { "maximum": 100, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthClaimTransform" }, "nullable": true }, "claims": { "maximum": 500, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "tokenType": { "$ref": "#/components/schemas/WsFedTokenTypes" }, "signatureAlgorithm": { "maxLength": 100, "type": "string", "nullable": true }, "issuer": { "maxLength": 300, "type": "string", "nullable": true }, "realm": { "maxLength": 300, "type": "string", "nullable": true }, "signInUrl": { "maxLength": 500, "type": "string", "nullable": true }, "signOutUrl": { "maxLength": 500, "type": "string", "nullable": true }, "keys": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/JwkWithCertificateInfo" }, "nullable": true }, "sessionLifetime": { "maximum": 43200, "minimum": 0, "type": "integer", "format": "int32" }, "sessionAbsoluteLifetime": { "maximum": 172800, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionAbsoluteLifetime": { "maximum": 31536000, "minimum": 0, "type": "integer", "format": "int32" }, "persistentSessionLifetimeUnlimited": { "type": "boolean" }, "disableSingleLogout": { "type": "boolean" }, "partyBindingPattern": { "$ref": "#/components/schemas/PartyBindingPatterns" }, "disableLoginHint": { "type": "boolean" }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true }, "hrdIPAddressesAndRanges": { "maximum": 20, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdDomains": { "maximum": 200, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdRegularExpressions": { "maximum": 10, "minimum": 0, "type": "array", "items": { "type": "string" }, "nullable": true }, "hrdAlwaysShowButton": { "type": "boolean" }, "hrdShowButtonWithDomain": { "type": "boolean", "nullable": true, "deprecated": true }, "hrdDisplayName": { "maxLength": 100, "pattern": "^[^<^>]*$", "type": "string", "nullable": true }, "hrdLogoUrl": { "maxLength": 500, "pattern": "^https:\\/\\/(?:www\\.|(?!www))[a-zA-Z0-9][a-zA-Z0-9-]+[a-zA-Z0-9]\\.[^\\s]{2,}", "type": "string", "nullable": true }, "linkExternalUser": { "$ref": "#/components/schemas/LinkExternalUser" }, "profiles": { "maximum": 20, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/WsFedUpPartyProfile" }, "nullable": true } }, "additionalProperties": false }, "WsFedUpPartyProfile": { "required": [ "displayName", "name" ], "type": "object", "properties": { "name": { "maxLength": 20, "minLength": 1, "pattern": "^[\\w\\-]*$", "type": "string" }, "newName": { "maxLength": 20, "pattern": "^[\\w\\-]*$", "type": "string", "nullable": true }, "displayName": { "maxLength": 100, "minLength": 1, "pattern": "^[\\w;:\\/\\-.,+()\\[\\]{} ]*$", "type": "string" }, "additionalParameters": { "maximum": 10, "minimum": 0, "type": "array", "items": { "$ref": "#/components/schemas/OAuthAdditionalParameter" }, "nullable": true } }, "additionalProperties": false }, "X509CertificateValidationMode": { "enum": [ "None", "PeerTrust", "ChainTrust", "PeerOrChainTrust", "Custom" ], "type": "string" }, "X509RevocationMode": { "enum": [ "NoCheck", "Online", "Offline" ], "type": "string" } }, "securitySchemes": { "Bearer": { "type": "http", "description": "JWT Authorization header. \r\n\r\n Enter the access token in the Value input below.", "scheme": "Bearer", "bearerFormat": "JWT" } } }, "security": [ { "Bearer": [ ] } ], "tags": [ { "name": "master clientsettings" }, { "name": "master filterplan" }, { "name": "master plan" }, { "name": "master plans" }, { "name": "master riskpassword" }, { "name": "master riskpasswordfirst" }, { "name": "master riskpasswordinfo" }, { "name": "master riskpasswordtest" }, { "name": "master smsprice" }, { "name": "master smsprices" }, { "name": "master usagesettings" }, { "name": "tenant accessstructure" }, { "name": "tenant accessstructurememberships" }, { "name": "tenant accessstructures" }, { "name": "tenant activesession" }, { "name": "tenant activesessions" }, { "name": "tenant downparties" }, { "name": "tenant downpartytest" }, { "name": "tenant externalloginsecretupparty" }, { "name": "tenant externalloginupparty" }, { "name": "tenant externaluser" }, { "name": "tenant externalusers" }, { "name": "tenant failingloginlock" }, { "name": "tenant failingloginlocks" }, { "name": "tenant filterdownparty" }, { "name": "tenant filterexternaluser" }, { "name": "tenant filterresourcename" }, { "name": "tenant filtertenant" }, { "name": "tenant filtertrack" }, { "name": "tenant filterupparty" }, { "name": "tenant filterusage" }, { "name": "tenant filterusagetenant" }, { "name": "tenant filteruser" }, { "name": "tenant loginupparty" }, { "name": "tenant mymolliefirstpayment" }, { "name": "tenant mytenant" }, { "name": "tenant mytenantlog" }, { "name": "tenant mytenantlogaudit" }, { "name": "tenant mytenantlogusage" }, { "name": "tenant myuser" }, { "name": "tenant newpartyname" }, { "name": "tenant oauthclientsecretdownparty" }, { "name": "tenant oauthdownparty" }, { "name": "tenant oauthupparty" }, { "name": "tenant oidcclientkeyupparty" }, { "name": "tenant oidcclientsecretdownparty" }, { "name": "tenant oidcclientsecretupparty" }, { "name": "tenant oidcdownparty" }, { "name": "tenant oidcupparty" }, { "name": "tenant planinfo" }, { "name": "tenant readcertificate" }, { "name": "tenant readcertificatefrompem" }, { "name": "tenant refreshtokengrant" }, { "name": "tenant refreshtokengrants" }, { "name": "tenant resourcecultures" }, { "name": "tenant resourcenames" }, { "name": "tenant samldownparty" }, { "name": "tenant samldownpartyreadmetadata" }, { "name": "tenant samlupparty" }, { "name": "tenant samluppartyreadmetadata" }, { "name": "tenant tenant" }, { "name": "tenant tenantlog" }, { "name": "tenant tenantlogaudit" }, { "name": "tenant tenantlogusage" }, { "name": "tenant tenants" }, { "name": "tenant track" }, { "name": "tenant trackclaimmapping" }, { "name": "tenant trackkeycontained" }, { "name": "tenant trackkeycontainedswap" }, { "name": "tenant trackkeytype" }, { "name": "tenant tracklargeresource" }, { "name": "tenant tracklargeresources" }, { "name": "tenant tracklinkdownparty" }, { "name": "tenant tracklinkupparty" }, { "name": "tenant tracklog" }, { "name": "tenant tracklogaudit" }, { "name": "tenant tracklogsetting" }, { "name": "tenant tracklogstreamssettings" }, { "name": "tenant tracklogusage" }, { "name": "tenant trackonlyresource" }, { "name": "tenant trackonlyresourcename" }, { "name": "tenant trackonlyresourcenames" }, { "name": "tenant trackresource" }, { "name": "tenant trackresourcesetting" }, { "name": "tenant tracks" }, { "name": "tenant tracksendemail" }, { "name": "tenant tracksendsms" }, { "name": "tenant upparties" }, { "name": "tenant usage" }, { "name": "tenant usageinvoicingaction" }, { "name": "tenant usages" }, { "name": "tenant usagetenants" }, { "name": "tenant user" }, { "name": "tenant userchangepassword" }, { "name": "tenant usercontrolprofile" }, { "name": "tenant userpasswordhistory" }, { "name": "tenant users" }, { "name": "tenant usersetpassword" }, { "name": "tenant wsfeddownparty" }, { "name": "tenant wsfeddownpartyreadmetadata" }, { "name": "tenant wsfedupparty" }, { "name": "tenant wsfeduppartyreadmetadata" }, { "name": "health" } ] }