{ "openapi" : "3.0.1", "info" : { "description" : "API documentation of Admin Portal - Admin Management", "title" : "Admin Portal - Admin Management", "version" : "v0.0.1" }, "servers" : [ { "url" : "https://{tenant}", "variables" : { "tenant" : { "default" : "example.strivacity.com", "description" : "Your Strivacity tenant" } } } ], "tags" : [ { "name" : "Adaptive Access Policy (Adaptive MFA)" }, { "name" : "Admin Account" }, { "name" : "Admin Account Attribute" }, { "name" : "Admin Account Event" }, { "name" : "Admin Account Invitation" }, { "name" : "Admin API Security Policy" }, { "name" : "Admin Claim" }, { "name" : "Admin External Login Mapping" }, { "name" : "Admin External Login Provider" }, { "name" : "Admin Role" }, { "name" : "Admin Role Assignee" }, { "name" : "Branding Policy" }, { "name" : "Custom Adaptive MFA" }, { "name" : "Notification Policy" }, { "name" : "Notification Template" }, { "name" : "Policy Tag" }, { "name" : "Tag Based Permission" } ], "paths" : { "/admin/api/v1/admin/accessPolicy" : { "get" : { "description" : "You can get the admin API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_api_access |\n", "operationId" : "getAdminApiAccessPolicy", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyResponse_ApiAccessPolicy" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_api_access" ] } ], "summary" : "Get admin API security policy", "tags" : [ "Admin API Security Policy" ] } }, "/admin/api/v1/admin/accessPolicy/assignments" : { "post" : { "description" : "You can create a client assignment for the admin API security policy by calling this endpoint. A client can only have one assignment.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_api_access |\n", "operationId" : "createApplicationAssignment", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentUpsertRequest_ApiAccessPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_admin_api_access" ] } ], "summary" : "Create a client assignment", "tags" : [ "Admin API Security Policy" ] } }, "/admin/api/v1/admin/accessPolicy/assignments/{clientId}" : { "delete" : { "description" : "You can delete a client assignment from the admin API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_api_access |\n", "operationId" : "deleteAdminApplicationAssignmentFromApiAccessPolicy", "parameters" : [ { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_api_access" ] } ], "summary" : "Delete a client assignment", "tags" : [ "Admin API Security Policy" ] }, "get" : { "description" : "You can get a client assignment to the admin API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_api_access |\n", "operationId" : "getAdminApiAccessPolicyByClientId", "parameters" : [ { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_api_access" ] } ], "summary" : "Get a client assignment", "tags" : [ "Admin API Security Policy" ] }, "put" : { "description" : "You can update a client assignment for the admin API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_api_access |\n", "operationId" : "updateApplicationAssignment", "parameters" : [ { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentUpsertRequest_ApiAccessPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_api_access" ] } ], "summary" : "Update a client assignment", "tags" : [ "Admin API Security Policy" ] } }, "/admin/api/v1/admin/adaptiveMfa" : { "get" : { "description" : "You can get the admin adaptive access policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_adaptive_mfa |\n", "operationId" : "getInternalAdaptiveMFA", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminAdaptiveAccessPolicyResponse_AdaptiveMFA" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_adaptive_mfa" ] } ], "summary" : "Get the admin adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] }, "put" : { "description" : "You can update the admin adaptive access policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_adaptive_mfa |\n", "operationId" : "updateInternalAdaptiveMFA", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminAdaptiveAccessPolicyUpdateRequest_AdaptiveMFA" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminAdaptiveAccessPolicyResponse_AdaptiveMFA" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "write:config_admin_adaptive_mfa" ] } ], "summary" : "Update the admin adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] } }, "/admin/api/v1/admin/adaptiveMfa/location" : { "get" : { "description" : "You can search for locations by a prefix with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_adaptive_mfa |\n", "operationId" : "getAdminMFAPolicyLocation", "parameters" : [ { "description" : "The filtering is applied for country, state and city.", "in" : "query", "name" : "location", "required" : true, "schema" : { "maxLength" : 2147483647, "minLength" : 3, "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationResponse_AdaptiveMFA" } } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_adaptive_mfa" ] } ], "summary" : "Filter for locations", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] } }, "/admin/api/v1/admin/brand" : { "get" : { "description" : "You can get the admin branding policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_brand |\n", "operationId" : "getInternalBrand", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminBranding_Brand" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_brand" ] } ], "summary" : "Get admin branding policy", "tags" : [ "Branding Policy" ] }, "put" : { "description" : "You can update the admin branding policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_brand |\n", "operationId" : "updateInternalBrand", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminBranding_Brand" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminBranding_Brand" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "write:config_admin_brand" ] } ], "summary" : "Update admin branding policy", "tags" : [ "Branding Policy" ] } }, "/admin/api/v1/admin/customMfas" : { "get" : { "description" : "You can list the existing custom mfas by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_custom_mfa |\n| read:config_admin_adaptive_mfa |\n| read:config_adaptive_mfa |\n", "operationId" : "list_2", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomMfaListResponse_CustomMfa" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_custom_mfa", "read:config_admin_adaptive_mfa", "read:config_adaptive_mfa" ] } ], "summary" : "List custom mfas", "tags" : [ "Custom Adaptive MFA" ] }, "post" : { "description" : "You can create a custom mfa by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_custom_mfa |\n", "operationId" : "create_2", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomMfaInsertRequest_CustomMfa" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomMfaResponse_CustomMfa" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_custom_mfa" ] } ], "summary" : "Create a custom mfa policy", "tags" : [ "Custom Adaptive MFA" ] } }, "/admin/api/v1/admin/customMfas/{id}" : { "delete" : { "description" : "You can delete a custom mfa by calling this endpoint. Custom mfa assigned to MFA policy assignments cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_custom_mfa |\n", "operationId" : "deleteAdaptiveMFAById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Custom mfa is assigned to an application or organization assignment" } }, "security" : [ { "securityScheme" : [ "delete:config_custom_mfa" ] } ], "summary" : "Delete a custom mfa", "tags" : [ "Custom Adaptive MFA" ] }, "get" : { "description" : "You can get a custom mfa by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_custom_mfa |\n", "operationId" : "getCustomMfa", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomMfaResponse_CustomMfa" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_custom_mfa" ] } ], "summary" : "Get a custom mfa", "tags" : [ "Custom Adaptive MFA" ] }, "put" : { "description" : "You can update a custom mfa by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_custom_mfa |\n", "operationId" : "updateCustomMFA", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomMfaUpdateRequest_CustomMfa" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomMfaResponse_CustomMfa" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_custom_mfa" ] } ], "summary" : "Update a custom mfa", "tags" : [ "Custom Adaptive MFA" ] } }, "/admin/api/v1/admin/events/account" : { "get" : { "description" : "You can list the admin account events by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_account |\n", "operationId" : "getAccountEvents", "parameters" : [ { "description" : "Labels used for filtering", "in" : "query", "name" : "labels", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "From which IP addresses the events have been initiated, used for filtering", "in" : "query", "name" : "actorIps", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Which accounts were involved in the events, used for filtering", "in" : "query", "name" : "subjectAccountIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Login session IDs used for filtering", "in" : "query", "name" : "loginSessionIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Filter against the given variant IDs or 'null'. Explicit 'null' means baseline variant.", "in" : "query", "name" : "variantIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Start date used for filtering", "in" : "query", "name" : "startDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering", "in" : "query", "name" : "endDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountEventHeaderResponse" } } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_event_account" ] } ], "summary" : "List admin account events", "tags" : [ "Admin Account Event" ] } }, "/admin/api/v1/admin/events/account/{eventId}" : { "get" : { "description" : "You can get an admin account event by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_account |\n", "operationId" : "getAccountEventById", "parameters" : [ { "in" : "path", "name" : "eventId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountEventResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_event_account" ] } ], "summary" : "Get an admin account event", "tags" : [ "Admin Account Event" ] } }, "/admin/api/v1/admin/events/descriptor" : { "get" : { "description" : "You can list the possible descriptors for admin account events by calling this endpoint. Descriptors for admin account events are in the following format: `(failure|success):{eventType}`.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_account |\n", "operationId" : "getDescriptor", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string", "example" : "success:login" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_event_account" ] } ], "summary" : "List descriptors for admin account events", "tags" : [ "Admin Account Event" ] } }, "/admin/api/v1/admin/events/notification" : { "get" : { "description" : "You can list the admin notification events by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_account |\n", "operationId" : "getNotificationEvents", "parameters" : [ { "description" : "The email address or phone number to which the notifications were sent", "in" : "query", "name" : "target", "required" : false, "schema" : { "type" : "string" } }, { "description" : "The accounts associated with the notification events", "in" : "query", "name" : "accountIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The invitations associated with the notification events", "in" : "query", "name" : "invitationIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The account events associated with the notification events", "in" : "query", "name" : "accountEventIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationEventListResponse" } } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_event_account" ] } ], "summary" : "List admin notification events", "tags" : [ "Admin Account Event" ] } }, "/admin/api/v1/admin/events/notification/{eventId}" : { "get" : { "description" : "You can get an admin notification event by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_account |\n", "operationId" : "getNotificationEventById", "parameters" : [ { "in" : "path", "name" : "eventId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationEventResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_event_account" ] } ], "summary" : "Get an admin notification event", "tags" : [ "Admin Account Event" ] } }, "/admin/api/v1/admin/identityStore/accounts" : { "get" : { "description" : "You can list the existing admin accounts by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n", "operationId" : "listAccounts", "parameters" : [ { "description" : "Account ID", "in" : "query", "name" : "id", "schema" : { "type" : "string" } }, { "description" : "Login identifier (username, email or phone). Start with `@` to search by email domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.", "in" : "query", "name" : "loginIdentifier", "schema" : { "type" : "string" } }, { "description" : "Attribute mapped to the Email native claim. Start with `@` to search by domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.", "in" : "query", "name" : "emailNativeClaim", "schema" : { "type" : "string" } }, { "description" : "User name in account info", "in" : "query", "name" : "userNameNativeClaim", "schema" : { "type" : "string" } }, { "description" : "Account is enabled or not", "in" : "query", "name" : "enabled", "schema" : { "type" : "boolean" } }, { "description" : "Start date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "updatedAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "updatedAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "createdAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "createdAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "disabledAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "disabledAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on lastLoggedIn field. Must not be provided if `neverLoggedIn` is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "lastLoginAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on lastLoggedIn field. Must not be provided if `neverLoggedIn` is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "lastLoginAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Flag to filter for accounts that have never logged in.", "in" : "query", "name" : "neverLoggedIn", "schema" : { "type" : "boolean" } }, { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "Role IDs used for filtering", "in" : "query", "name" : "roles" }, { "description" : "Type of inclusion used for roles filter. By setting to `exclude` makes it an `AND` relationship within the values of the roles parameter.", "in" : "query", "name" : "rolesFilter", "schema" : { "type" : "string", "enum" : [ "include", "exclude" ] } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountResponse_Account" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_account" ] } ], "summary" : "List admin accounts", "tags" : [ "Admin Account" ] }, "post" : { "description" : "You can create an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "createAccount", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountInsertRequest_Account" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountResponse_Account" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Create an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}" : { "delete" : { "description" : "You can delete an admin account by calling this endpoint. Admin accounts cannot delete themselves. The last existing admin account cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:admin_account |\n", "operationId" : "deleteAccountById", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Administrator accounts cannot delete themselves" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "The last assigned admin cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:admin_account" ] } ], "summary" : "Delete an admin account", "tags" : [ "Admin Account" ] }, "get" : { "description" : "You can get an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n", "operationId" : "getAccountById", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountResponse_Account" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_account" ] } ], "summary" : "Get an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/authenticators" : { "post" : { "description" : "You can create an authenticator for an admin account by calling this endpoint. Authenticator type can be either `email` or `phone`.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account_authenticator |\n", "operationId" : "addAuthenticator", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AuthenticatorAdminInsertRequest_Account" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AuthenticatorResponse_Account" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:admin_account_authenticator" ] } ], "summary" : "Create authenticator for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/authenticators/{authenticatorId}" : { "delete" : { "description" : "You can delete an authenticator for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:admin_account_authenticator |\n", "operationId" : "deleteAuthenticator", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "authenticatorId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "delete:admin_account_authenticator" ] } ], "summary" : "Delete authenticator for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/disable" : { "post" : { "description" : "You can disable an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "disableAccount", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Disable an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/download" : { "get" : { "description" : "You can download the admin account information in HTML or JSON format by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account_download |\n", "operationId" : "getPersonalData", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "fileType", "required" : true, "schema" : { "pattern" : "html|json", "type" : "string", "enum" : [ "html", "json" ] } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "string" } } }, "description" : "OK", "headers" : { "Content-Disposition" : { "schema" : { "type" : "string", "example" : "attachment; filename=\"{filename}\"" }, "style" : "simple" } } }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Invalid file type or file type is not present" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_account_download" ] } ], "summary" : "Download admin account information", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/enable" : { "post" : { "description" : "You can enable an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "enableAccount", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Enable an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/identities" : { "get" : { "description" : "You can list the existing identities for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account_identity |\n", "operationId" : "getIdentities", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentitiesResponse_Identities" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_account_identity" ] } ], "summary" : "List identities for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/identities/identifier" : { "post" : { "description" : "You can update the identifier for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account_identity |\n", "operationId" : "updateAccountIdentifier", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountIdentifierUpdateRequest_Account" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentitiesResponse_Account" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:admin_account_identity" ] } ], "summary" : "Update identifier for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/liftPasscodeLock" : { "post" : { "description" : "You can lift passcode lock for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "liftPasscodeLock", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Lift passcode lock for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/liftPasswordLock" : { "post" : { "description" : "You can lift password lock for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "liftPasswordLock", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Lift password lock for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/password/change" : { "post" : { "description" : "You can change the password for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account_authenticator |\n", "operationId" : "resetPassword", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordResetRequest_Account" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account_authenticator" ] } ], "summary" : "Change password for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/password/reset" : { "post" : { "description" : "You can request a password reset for an admin account by calling this endpoint. A password reset email will be sent to the email address of the corresponding admin account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account_authenticator |\n", "operationId" : "adminInitiatedForgottenPassword", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account_authenticator" ] } ], "summary" : "Request password reset for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/personal" : { "put" : { "description" : "You can update metadata for an admin account by calling this endpoint. Only the given attributes will be modified. After a successful update, the entire metadata will be returned. Attributes provided with an explicit `null` value won't be overridden by external metadata values.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "updateLocalMetadata", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Update metadata for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/roles" : { "post" : { "description" : "You can assign one or more roles to an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "addRolesToAccount", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_Account" } } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Assign multiple roles to an account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/sessions" : { "delete" : { "description" : "You can clear the sessions for an admin account by calling this endpoint. Note that clearing sessions for an admin account results in logging out of all browsers that admin had been logged into previously. This performs a back-channel logout on the specified admin account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "clearAccountDeviceSessions", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Clear sessions for an admin account", "tags" : [ "Admin Account" ] }, "get" : { "description" : "You can list the sessions for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n", "operationId" : "getIdentifiedAccountDeviceSessions", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentifiedSessionResponse_Account" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_account" ] } ], "summary" : "List sessions for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/accounts/{accountId}/sessions/{sessionId}" : { "delete" : { "description" : "You can delete a session for an admin account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "deleteAccountDeviceSession", "parameters" : [ { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "sessionId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Delete session for an admin account", "tags" : [ "Admin Account" ] } }, "/admin/api/v1/admin/identityStore/attributes" : { "get" : { "description" : "You can list the existing admin account attributes by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "getAllAccountAttributes", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/CheckboxAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/DateAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/IdentifierAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/PasswordAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/PhoneNumberAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/SelectAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/StringAccountAttribute_AccountAttribute" }, { "$ref" : "#/components/schemas/UsernameIdentifierAttributeDTO_AccountAttribute" } ] } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List admin account attributes", "tags" : [ "Admin Account Attribute" ] } }, "/admin/api/v1/admin/identityStore/availableNativeClaims" : { "get" : { "description" : "You can list the native claims that are still not assigned to an account attribute.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "getAvailableNativeClaims", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NativeClaimResponse_NativeClaim" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List available native claims", "tags" : [ "Admin Claim" ] } }, "/admin/api/v1/admin/identityStore/invite" : { "get" : { "description" : "You can list the existing admin account invitations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n", "operationId" : "getAccountInvitations", "parameters" : [ { "description" : "Invitation has been accepted or not", "in" : "query", "name" : "accepted", "required" : false, "schema" : { "type" : "boolean" } }, { "description" : "Invitation email used for filtering", "in" : "query", "name" : "email", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Organization ID used for filtering", "in" : "query", "name" : "organization", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Unique identifier organization ID used for filtering", "in" : "query", "name" : "organizationScope", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdminAccountInvitationResponse_Account" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:admin_account" ] } ], "summary" : "List admin account invitations", "tags" : [ "Admin Account Invitation" ] }, "post" : { "description" : "You can create an admin account invitation by calling this endpoint. An invite will be sent to the given email address to register a new admin account. If a pending invitation exists with the given email address, the response contains the existing invitation ID. If an admin account exists with the given email address, the invitation will not be sent, because email mismatch is not allowed for admin invites.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "createInvitation", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountInvitationInsertRequest_AccountInvitationDetails" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountInvitationResponse_AccountInvitationDetails" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/InvitationConflictProblemJson_AccountInvitationDetails" } } }, "description" : "Admin account with this email identifier already exists or an invitation with this email identifier already exists. When an invitation already exists, a `conflictingId` field will be returned in addition, which points to the already existing invitation." } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Create an admin account invitation", "tags" : [ "Admin Account Invitation" ] } }, "/admin/api/v1/admin/identityStore/invite/{invitationId}" : { "delete" : { "description" : "You can revoke an admin account invitation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "deleteAccountInvitation", "parameters" : [ { "in" : "path", "name" : "invitationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Revoke an admin account invitation", "tags" : [ "Admin Account Invitation" ] }, "get" : { "description" : "You can get an admin account invitation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n", "operationId" : "getAccountInvitation", "parameters" : [ { "in" : "path", "name" : "invitationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountInvitationResponse_AccountInvitationDetails" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_account" ] } ], "summary" : "Get an admin account invitation", "tags" : [ "Admin Account Invitation" ] } }, "/admin/api/v1/admin/identityStore/invite/{invitationId}/resend" : { "post" : { "description" : "You can resend an admin account invitation by calling this endpoint. Once an invite is sent, the `validUntil` field is updated.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n", "operationId" : "resendInvitation", "parameters" : [ { "in" : "path", "name" : "invitationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountInvitationResponse_AccountInvitationDetails" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account" ] } ], "summary" : "Resend an admin account invitation", "tags" : [ "Admin Account Invitation" ] } }, "/admin/api/v1/admin/identityStore/nativeClaimMappings" : { "get" : { "description" : "You can list the native claims with the assigned account attributes.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "getNativeClaimMappings", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List native claim mappings", "tags" : [ "Admin Claim" ] } }, "/admin/api/v1/admin/identityStore/roles" : { "get" : { "description" : "You can list the existing admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "list", "parameters" : [ { "description" : "Role IDs used for filtering", "in" : "query", "name" : "ids", "required" : false, "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Name used for filtering", "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PageAdminRoleResponse_AdminRole" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List admin roles", "tags" : [ "Admin Role" ] }, "post" : { "description" : "You can create an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "create", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminRole_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminRoleResponse_AdminRole" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Create an admin role", "tags" : [ "Admin Role" ] } }, "/admin/api/v1/admin/identityStore/roles/scopes" : { "get" : { "description" : "You can list the existing scopes by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "getAllScopes", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeAdminResponse_AdminRole" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List scopes", "tags" : [ "Admin Role" ] } }, "/admin/api/v1/admin/identityStore/roles/{id}" : { "delete" : { "description" : "You can delete an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "delete_2", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Roles that has accounts assigned to cannot be deleted." }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Admin role cannot be deleted." } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Delete an admin role", "tags" : [ "Admin Role" ] }, "get" : { "description" : "You can get an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "get_1", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminRoleResponse_AdminRole" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "Get an admin role", "tags" : [ "Admin Role" ] }, "put" : { "description" : "You can update an admin role by calling this endpoint. The default admin role cannot be modified.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "update_1", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminRoleUpsertRequest_AdminRole" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminRoleResponse_AdminRole" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Update an admin role", "tags" : [ "Admin Role" ] } }, "/admin/api/v1/admin/identityStore/roles/{roleId}/assignees" : { "get" : { "description" : "You can list the admin role assignees by calling this endpoint. To use this endpoint, both `read:admin_account` and `read:config_identity_store` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_account |\n| read:config_admin_identity_store |\n", "operationId" : "listRoleAssignees", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Account ID", "in" : "query", "name" : "id", "schema" : { "type" : "string" } }, { "description" : "Login identifier (username, email or phone). Start with `@` to search by email domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.", "in" : "query", "name" : "loginIdentifier", "schema" : { "type" : "string" } }, { "description" : "Attribute mapped to the Email native claim. Start with `@` to search by domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.", "in" : "query", "name" : "emailNativeClaim", "schema" : { "type" : "string" } }, { "description" : "User name in account info", "in" : "query", "name" : "userNameNativeClaim", "schema" : { "type" : "string" } }, { "description" : "Account is enabled or not", "in" : "query", "name" : "enabled", "schema" : { "type" : "boolean" } }, { "description" : "Start date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "updatedAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "updatedAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "createdAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "createdAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "disabledAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "disabledAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Start date used for filtering based on lastLoggedIn field. Must not be provided if `neverLoggedIn` is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "lastLoginAtStartDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "End date used for filtering based on lastLoggedIn field. Must not be provided if `neverLoggedIn` is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.", "in" : "query", "name" : "lastLoginAtEndDate", "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Flag to filter for accounts that have never logged in.", "in" : "query", "name" : "neverLoggedIn", "schema" : { "type" : "boolean" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountResponse_Account" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:admin_account", "read:config_admin_identity_store" ] } ], "summary" : "List role assignees", "tags" : [ "Admin Role Assignee" ] }, "post" : { "description" : "You can assign an admin account to a role by calling this endpoint. To use this endpoint, both `write:admin_account` and `read:config_identity_store` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n| read:config_admin_identity_store |\n", "operationId" : "assignRole", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminAccountAssignee_Account" } } }, "required" : true }, "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:admin_account", "read:config_admin_identity_store" ] } ], "summary" : "Assign an admin account to a role", "tags" : [ "Admin Role Assignee" ] } }, "/admin/api/v1/admin/identityStore/roles/{roleId}/assignees/{accountId}" : { "delete" : { "description" : "You can unassign a role from an admin account by calling this endpoint. To use this endpoint, both `write:admin_account` and `read:config_identity_store` scopes should be granted. The Admin role cannot be unassigned from the last admin account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_account |\n| read:config_admin_identity_store |\n", "operationId" : "removeRole", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "The Admin role cannot be unassigned from the last admin account." } }, "security" : [ { "securityScheme" : [ "write:admin_account", "read:config_admin_identity_store" ] } ], "summary" : "Remove an admin account from a role", "tags" : [ "Admin Role Assignee" ] } }, "/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions" : { "get" : { "description" : "You can list the existing tag based permissions for an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "list_1", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Tags used for filtering must exactly match the tag name", "in" : "query", "name" : "policyTags", "required" : false, "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "List tag based permissions", "tags" : [ "Tag Based Permission" ] }, "post" : { "description" : "You can create tag based permissions for an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "create_1", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagBasedPermissionInsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TagBasedPermissionResponse" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Create tag based permissions for an admin role", "tags" : [ "Tag Based Permission" ] } }, "/admin/api/v1/admin/identityStore/roles/{roleId}/tagBasedPermissions/{id}" : { "delete" : { "description" : "You can delete a tag based permission entry for an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "delete_1", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Delete a tag based permission entry", "tags" : [ "Tag Based Permission" ] }, "get" : { "description" : "You can get a tag based permission entry for an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_identity_store |\n", "operationId" : "get", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TagBasedPermissionResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_identity_store" ] } ], "summary" : "Get a tag based permission entry", "tags" : [ "Tag Based Permission" ] }, "put" : { "description" : "You can update a tag based permission entry for an admin role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_identity_store |\n", "operationId" : "update", "parameters" : [ { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TagBasedPermissionUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TagBasedPermissionResponse" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_identity_store" ] } ], "summary" : "Update a tag based permission entry", "tags" : [ "Tag Based Permission" ] } }, "/admin/api/v1/admin/loginProviders" : { "get" : { "description" : "You can list the admin external login providers by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_login_provider |\n| read:admin_account |\n| read:admin_account_identity |\n", "operationId" : "getExternalLoginProviders", "parameters" : [ { "description" : "Name used for filtering", "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/PageOfExternalLoginProviderNameAndIdAndType" }, { "$ref" : "#/components/schemas/PageOfGenericLoginProviderResponse" } ] } } }, "description" : "| TYPE | REQUESTED WITH |\n|:----------------- | ----------------|\n| PageOfNameAndIdAndType | `read:admin_account` or `read:admin_account_identity` scope |\n| PageOfGenericLoginProviderResponse | `read:config_admin_login_provider` scope |" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_login_provider", "read:admin_account", "read:admin_account_identity" ] } ], "summary" : "List admin external login providers", "tags" : [ "Admin External Login Provider" ] }, "post" : { "description" : "You can create an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_login_provider |\n", "operationId" : "createExternalLoginProvider", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderRequest_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderResponse" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_admin_login_provider" ] } ], "summary" : "Create an admin external login provider", "tags" : [ "Admin External Login Provider" ] } }, "/admin/api/v1/admin/loginProviders/{id}" : { "delete" : { "description" : "You can delete an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_login_provider |\n", "operationId" : "deleteExternalLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_login_provider" ] } ], "summary" : "Delete an admin external login provider", "tags" : [ "Admin External Login Provider" ] }, "get" : { "description" : "You can get an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_login_provider |\n", "operationId" : "getExternalLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_login_provider" ] } ], "summary" : "Get an admin external login provider", "tags" : [ "Admin External Login Provider" ] }, "put" : { "description" : "You can update an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_login_provider |\n", "operationId" : "updateExternalLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderResponse" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_admin_login_provider" ] } ], "summary" : "Update an admin external login provider", "tags" : [ "Admin External Login Provider" ] } }, "/admin/api/v1/admin/loginProviders/{providerId}/availableNativeClaims" : { "get" : { "description" : "You can list the available native claims for an admin external login provider by calling this endpoint. A native claim is listed if it's not assigned to an external login provider. A native claim with name `id` will not be listed.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_login_provider |\n", "operationId" : "getNotAssignedNativeClaims", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_login_provider" ] } ], "summary" : "List available native claims", "tags" : [ "Admin External Login Mapping" ] } }, "/admin/api/v1/admin/loginProviders/{providerId}/mappings" : { "get" : { "description" : "You can list the claim mappings for an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_login_provider |\n", "operationId" : "getEnterpriseLoginMappings", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PageExternalLoginMappingResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_login_provider" ] } ], "summary" : "List claim mappings", "tags" : [ "Admin External Login Mapping" ] }, "post" : { "description" : "You can create a mapping to a native claim for an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_login_provider |\n", "operationId" : "createEnterpriseLoginMapping", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalLogin_Mapping_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ExternalLoginMappingResponse" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Native claim mapping already assigned to login provider" } }, "security" : [ { "securityScheme" : [ "write:config_admin_login_provider" ] } ], "summary" : "Create a claim mapping", "tags" : [ "Admin External Login Mapping" ] } }, "/admin/api/v1/admin/loginProviders/{providerId}/mappings/{id}" : { "delete" : { "description" : "You can delete a claim mapping for an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_login_provider |\n", "operationId" : "delete", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_login_provider" ] } ], "summary" : "Delete claim mapping", "tags" : [ "Admin External Login Mapping" ] }, "get" : { "description" : "You can get a claim mapping for an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_login_provider |\n", "operationId" : "getEnterpriseLoginMapping", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ExternalLoginMappingResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_login_provider" ] } ], "summary" : "Get a claim mapping", "tags" : [ "Admin External Login Mapping" ] }, "put" : { "description" : "You can update a claim mapping for an admin external login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_login_provider |\n", "operationId" : "updateGenericOIDCMapping", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ExternalLoginMappingUpsertRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ExternalLoginMappingResponse" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Native claim mapping already assigned to login provider" } }, "security" : [ { "securityScheme" : [ "write:config_admin_login_provider" ] } ], "summary" : "Update claim mapping", "tags" : [ "Admin External Login Mapping" ] } }, "/admin/api/v1/admin/notificationPolicy" : { "get" : { "description" : "You can get admin notification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_notification_policy |\n", "operationId" : "getAdminNotificationPolicy", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminNotificationPolicyResponse" } } }, "description" : "OK" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_notification_policy" ] } ], "summary" : "Get admin notification policy", "tags" : [ "Notification Policy" ] }, "put" : { "description" : "You can update admin notification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_notification_policy |\n", "operationId" : "updateAdminNotificationPolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdminNotificationPolicyUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdminNotificationPolicyResponse" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "write:config_admin_notification_policy" ] } ], "summary" : "Update admin notification policy", "tags" : [ "Notification Policy" ] } }, "/admin/api/v1/admin/notificationPolicy/email/{id}" : { "put" : { "description" : "You can update an admin notification template for an email type and ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_notification_policy |\n", "operationId" : "updateAdminNotificationTemplateEmail", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationTemplateEmailUpdateRequest_NotificationTemplate" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationTemplateDTO_NotificationTemplate" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_notification_policy" ] } ], "summary" : "Update an admin notification template (email)", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/admin/notificationPolicy/sms/{id}" : { "put" : { "description" : "You can update an admin notification template for an SMS type and ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_notification_policy |\n", "operationId" : "updateAdminNotificationTemplateSMS", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationTemplateSMSUpdateRequest_NotificationTemplate" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationTemplateDTO_NotificationTemplate" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_notification_policy" ] } ], "summary" : "Update an admin notification template (SMS)", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/admin/notificationPolicy/{type}" : { "get" : { "description" : "You can list the existing admin notification templates by a notification type with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_notification_policy |\n", "operationId" : "getAdminNotificationTemplateParameters", "parameters" : [ { "in" : "path", "name" : "type", "required" : true, "schema" : { "type" : "string", "enum" : [ "sms", "email" ] } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationTemplateResponse_NotificationTemplateMetainfo" } } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_notification_policy" ] } ], "summary" : "List admin notification templates", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/admin/notificationPolicy/{type}/{id}" : { "get" : { "description" : "You can get an admin notification template by a notification type and ID with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_notification_policy |\n", "operationId" : "getAdminNotificationTemplate", "parameters" : [ { "in" : "path", "name" : "type", "required" : true, "schema" : { "type" : "string", "enum" : [ "sms", "email" ] } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationTemplateDTO_NotificationTemplate" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_notification_policy" ] } ], "summary" : "Get an admin notification template", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/admin/policyTags" : { "get" : { "description" : "You can list the existing policy tags by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_policy_tag |\n", "operationId" : "getAllTags", "parameters" : [ { "description" : "Name used for filtering", "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Zero-based page index (0..N)", "in" : "query", "name" : "page", "schema" : { "type" : "integer", "format" : "int64", "default" : 0 } }, { "description" : "The size of the page to be returned", "in" : "query", "name" : "size", "schema" : { "type" : "integer", "format" : "int64", "default" : 20 } }, { "description" : "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.", "in" : "query", "name" : "sort", "schema" : { "type" : "array", "items" : { "type" : "string" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/PageOfPolicyTagResponse" }, { "$ref" : "#/components/schemas/PageOfNameAndColorResponse" } ] } } }, "description" : "| TYPE | REQUESTED WITH SCOPE |\n|:----------------- | ----------------|\n| PageOfNameAndColorResponse | if no scope is defined |\n| PageOfPolicyTagResponse | if `read:config_admin_policy_tag` scope is defined |" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" } }, "security" : [ { "securityScheme" : [ "read:config_admin_policy_tag" ] } ], "summary" : "List policy tags", "tags" : [ "Policy Tag" ] }, "post" : { "description" : "You can create a policy tag by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_policy_tag |\n", "operationId" : "createTag", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PolicyTagUpsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PolicyTagResponse" } } }, "description" : "Created" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Tag already exists with the same name" } }, "security" : [ { "securityScheme" : [ "write:config_admin_policy_tag" ] } ], "summary" : "Create a policy tag", "tags" : [ "Policy Tag" ] } }, "/admin/api/v1/admin/policyTags/{name}" : { "delete" : { "description" : "You can delete a policy tag by calling this endpoint. Assigned policy tags cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_policy_tag |\n", "operationId" : "deleteTag", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "This policy tag still assigned and cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_policy_tag" ] } ], "summary" : "Delete a policy tag", "tags" : [ "Policy Tag" ] }, "get" : { "description" : "You can get an existing policy tag by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_policy_tag |\n", "operationId" : "getPolicyTag", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/PolicyTagResponse" }, { "$ref" : "#/components/schemas/NameAndColorResponse" } ] } } }, "description" : "| TYPE | REQUESTED WITH SCOPE |\n|:----------------- | ----------------|\n| PageOfNameAndColorResponse | if no scope is defined |\n| PageOfPolicyTagResponse | if `read:config_admin_policy_tag` scope is defined |" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_admin_policy_tag" ] } ], "summary" : "Get a policy tag", "tags" : [ "Policy Tag" ] }, "put" : { "description" : "You can update a policy tag by calling this endpoint. The name of a policy tag cannot be altered.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_policy_tag |\n", "operationId" : "updateTag", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PolicyTagUpsertRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PolicyTagResponse" } } }, "description" : "OK" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Bad Request" }, "401" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Unauthorized" }, "403" : { "content" : { "application/problem+json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Forbidden" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_admin_policy_tag" ] } ], "summary" : "Update a policy tag", "tags" : [ "Policy Tag" ] } } }, "components" : { "schemas" : { "AccountAttributeConnector_AccountAttribute" : { "type" : "object", "properties" : { "readFromPath" : { "maxLength" : 256, "minLength" : 1, "type" : "string" } }, "description" : "Represents the connector related configurations" }, "AccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "properties" : { "connector" : { "$ref" : "#/components/schemas/AccountAttributeConnector_AccountAttribute" }, "displayName" : { "maxLength" : 128, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "displayOnAdminConsole" : { "type" : "boolean", "default" : false }, "displayOnMyAccount" : { "type" : "boolean", "default" : false }, "displayOnOrganizationPortal" : { "type" : "boolean", "default" : false }, "displayOnRegistration" : { "type" : "boolean", "default" : false }, "editableOnAdminConsole" : { "type" : "boolean", "default" : false }, "editableOnMyAccount" : { "type" : "boolean", "default" : false }, "editableOnOrganizationPortal" : { "type" : "boolean", "default" : false }, "enabled" : { "type" : "boolean", "default" : false }, "frontendHook" : { "$ref" : "#/components/schemas/FrontendHook_AccountAttribute" }, "id" : { "type" : "string" }, "indexing" : { "type" : "string", "description" : "Defines searchability for an attribute. Possible values: `none` - Not searchable, `searchOnly` - Searchable, `searchUnique` - Searchable and unique to identity store, `searchUniqueInOrganization` - Searchable and unique to organization", "enum" : [ "none", "searchOnly", "searchUnique", "searchUniqueInOrganization" ] }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^[a-zA-Z][a-zA-Z0-9_]*$", "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/NativeClaim_AccountAttribute" }, "path" : { "maxLength" : 128, "minLength" : 0, "pattern" : "^([a-zA-Z][a-zA-Z0-9_.]*)*$", "type" : "string", "description" : "Default value is an empty string" }, "required" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "STRING", "CHECKBOX", "SELECT", "PHONE_NUMBER", "DATE", "PASSWORD", "USERNAME_IDENTIFIER", "EMAIL_IDENTIFIER", "PHONE_IDENTIFIER" ] } }, "description" : "Represents an account attribute", "discriminator" : { "propertyName" : "type" } }, "AccountEventHeaderResponse" : { "type" : "object", "properties" : { "actor" : { "$ref" : "#/components/schemas/EventActor" }, "actorApplication" : { "$ref" : "#/components/schemas/ActorApplication" }, "endTimestamp" : { "type" : "string", "format" : "date-time" }, "eventId" : { "type" : "string", "format" : "uuid" }, "labels" : { "type" : "array", "description" : "Labels indicating what happened during the occurrence of the event.Labels are in the following format: `(failure|success):{eventType}`", "items" : { "type" : "string", "example" : "success:login" } }, "loginSessionId" : { "type" : "string" }, "startTimestamp" : { "type" : "string", "format" : "date-time" }, "subject" : { "$ref" : "#/components/schemas/Subject" }, "type" : { "type" : "string", "description" : "Gives additional context for an account event. An example for each event type: `customerFlow` - an account tries to log in, `selfService` - an account modifies their own metadata, `administrative` - an admin modifies metadata for an account", "enum" : [ "customerFlow", "selfService", "administrative", "scheduled", "bulkOperation" ] }, "variantId" : { "type" : "string" } }, "description" : "Represents an account event header. Fields with empty values are not included in the response." }, "AccountEventResponse" : { "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ActionResponse" } }, "actor" : { "$ref" : "#/components/schemas/EventActor" }, "actorApplication" : { "$ref" : "#/components/schemas/ActorApplication" }, "endTimestamp" : { "type" : "string", "format" : "date-time" }, "eventId" : { "type" : "string", "format" : "uuid" }, "labels" : { "type" : "array", "description" : "Labels indicating what happened during the occurrence of the event.Labels are in the following format: `(failure|success):{eventType}`", "items" : { "type" : "string", "example" : "success:login" } }, "loginSessionId" : { "type" : "string" }, "startTimestamp" : { "type" : "string", "format" : "date-time" }, "subject" : { "$ref" : "#/components/schemas/Subject" }, "type" : { "type" : "string", "description" : "Gives additional context for an account event. An example for each event type: `customerFlow` - an account tries to log in, `selfService` - an account modifies their own metadata, `administrative` - an admin modifies metadata for an account", "enum" : [ "customerFlow", "selfService", "administrative", "scheduled", "bulkOperation" ] }, "variantId" : { "type" : "string" } }, "description" : "Represents an account event. Fields with empty values are not included in the response." }, "AccountIdentifierUpdateRequest_Account" : { "required" : [ "type" ], "type" : "object", "properties" : { "identifier" : { "type" : "string" }, "type" : { "type" : "string", "description" : "Identifier method used by identity stores", "enum" : [ "username", "email", "phone" ] } } }, "AccountInsertRequest.Email_Account" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Represents the email identifier", "example" : "john@example.com" }, "verified" : { "type" : "boolean", "default" : false } } }, "AccountLock_Account" : { "type" : "object", "properties" : { "until" : { "type" : "string", "description" : "null in case of permanent lock, otherwise temporary lock", "format" : "date-time" } }, "description" : "Represents a lock on the account" }, "AccountLockoutResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "passcode" : { "$ref" : "#/components/schemas/LockoutResponse_AdaptiveMFA" }, "password" : { "$ref" : "#/components/schemas/LockoutResponse_AdaptiveMFA" } }, "description" : "Represents account lockout object." }, "AccountLockout_Account" : { "type" : "object", "properties" : { "failedPasscodeAttemptCount" : { "type" : "integer", "format" : "int32" }, "failedPasscodeAttemptCountPermanentLock" : { "type" : "integer", "format" : "int32" }, "failedPasswordAttemptCount" : { "type" : "integer", "format" : "int32" }, "failedPasswordAttemptCountPermanentLock" : { "type" : "integer", "format" : "int32" }, "locks" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AccountLock_Account" } } }, "description" : "Represents the account lockout details" }, "AccountLockout_AdaptiveMFA" : { "required" : [ "passcode", "password" ], "type" : "object", "properties" : { "passcode" : { "$ref" : "#/components/schemas/Lockout_AdaptiveMFA" }, "password" : { "$ref" : "#/components/schemas/Lockout_AdaptiveMFA" } }, "description" : "Represents the account lockout configuration" }, "AccountProofingWithNameAndDeletedResponse_Account" : { "type" : "object", "properties" : { "attempts" : { "type" : "integer", "format" : "int64" }, "deleted" : { "type" : "boolean" }, "id" : { "type" : "string", "format" : "uuid" }, "invalidatedAt" : { "type" : "string", "format" : "date-time" }, "policyId" : { "type" : "string" }, "proofedAt" : { "type" : "string", "format" : "date-time" } } }, "AccountResponse_Account" : { "type" : "object", "properties" : { "accountInfo" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Contains metadata for an account" }, "description" : "Contains metadata for an account" }, "accountLockout" : { "$ref" : "#/components/schemas/AccountLockout_Account" }, "accountProofings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountProofingWithNameAndDeletedResponse_Account" } }, "authenticators" : { "$ref" : "#/components/schemas/AuthenticatorsResponse_Account" }, "consents" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConsentResponse_Account" } }, "createdAt" : { "type" : "string", "format" : "date-time" }, "disabledAt" : { "type" : "string", "format" : "date-time" }, "enabled" : { "type" : "boolean" }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_Account" } }, "id" : { "type" : "string" }, "identities" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Contains identities for an account, like email, username and local metadata" }, "description" : "Contains identities for an account, like email, username and local metadata" }, "language" : { "type" : "string" }, "lastLogin" : { "$ref" : "#/components/schemas/LastLoginResponse_Account" }, "numberOfLogins" : { "type" : "integer", "format" : "int64" }, "organization" : { "type" : "string", "description" : "ID of the represented organization. If the value is null, the account is non-organizational." }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountRole_Account" } }, "store" : { "type" : "string", "description" : "Name of the represented identity store" }, "updatedAt" : { "type" : "string", "format" : "date-time" } } }, "AccountRole_Account" : { "required" : [ "id", "organization" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented role" }, "organization" : { "type" : "string", "description" : "ID of the represented organization" } }, "description" : "Represents an organization-role assignment" }, "AccountRole_AccountInvitationDetails" : { "required" : [ "id", "organization" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented role" }, "organization" : { "type" : "string", "description" : "ID of the represented organization" } }, "description" : "Represents an organization-role assignment" }, "ActionResponse" : { "type" : "object", "properties" : { "actor" : { "$ref" : "#/components/schemas/EventActor" }, "details" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Detail" } }, "http" : { "$ref" : "#/components/schemas/Http" }, "notifications" : { "type" : "array", "items" : { "type" : "string" } }, "timestamp" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string", "description" : "Gives additional context for an account event. An example for each event type: `customerFlow` - an account tries to log in, `selfService` - an account modifies their own metadata, `administrative` - an admin modifies metadata for an account", "enum" : [ "customerFlow", "selfService", "administrative", "scheduled", "bulkOperation" ] } } }, "ActorApplication" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } }, "description" : "Application in which the actor initiated the event" }, "AdaptiveAccessPolicyLocationRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Represents a type of inclusion", "default" : "include", "enum" : [ "include", "exclude" ] }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LocationValueRequest_AdaptiveMFA" }, "default" : [ ] } }, "description" : "Location rules to be used for an adaptive access policy" }, "AdaptiveAccessPolicyLocationResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Represents a type of inclusion", "enum" : [ "include", "exclude" ] }, "values" : { "type" : "array", "description" : "Represents a list of locations", "items" : { "$ref" : "#/components/schemas/LocationValueResponse_AdaptiveMFA" } } }, "description" : "Location rules defined for an adaptive access policy" }, "AdaptiveAccessPolicyMFAResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "customMfaAssignments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_AdaptiveMFA" } }, "email" : { "$ref" : "#/components/schemas/OutOfBandFactorResponse_AdaptiveMFA" }, "enforceSecondFactor" : { "type" : "boolean" }, "magicLinkLifetimeMinutes" : { "type" : "integer", "format" : "int32" }, "passcodeLength" : { "type" : "integer", "format" : "int32" }, "passcodeLifetimeMinutes" : { "type" : "integer", "format" : "int32" }, "passkey" : { "$ref" : "#/components/schemas/PasskeyFactorResponse_AdaptiveMFA" }, "phone" : { "$ref" : "#/components/schemas/OutOfBandFactorResponse_AdaptiveMFA" }, "skipAuthenticatorSelectEnrollScreen" : { "type" : "boolean" }, "skipMethodSelectionEnabled" : { "type" : "boolean" }, "softToken" : { "$ref" : "#/components/schemas/SoftTokenFactorResponse_AdaptiveMFA" }, "webAuthnDeviceBiometrics" : { "$ref" : "#/components/schemas/FactorResponse_AdaptiveMFA" }, "webAuthnSecurityKey" : { "$ref" : "#/components/schemas/FactorResponse_AdaptiveMFA" } }, "description" : "Represents an adaptive access policy configuration" }, "AdminAccountAssignee_Account" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "Admin account ID" } }, "description" : "Represents an admin account" }, "AdminAccountInsertLocal_Account" : { "type" : "object", "properties" : { "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents metadata for account information", "example" : "{\n \"name\": {\n \"givenName\": \"John\"\n \"familyName\": \"Doe\"\n }\n}" }, "description" : "Represents metadata for account information", "example" : "{\n \"name\": {\n \"givenName\": \"John\"\n \"familyName\": \"Doe\"\n }\n}" } } }, "AdminAccountInsertRequest_Account" : { "type" : "object", "properties" : { "email" : { "$ref" : "#/components/schemas/AccountInsertRequest.Email_Account" }, "local" : { "$ref" : "#/components/schemas/AdminAccountInsertLocal_Account" }, "password" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "skipPasswordPolicy" : { "type" : "boolean", "default" : false } } }, "AdminAccountInvitationInsertRequest_AccountInvitationDetails" : { "required" : [ "email", "metadata", "roles" ], "type" : "object", "properties" : { "email" : { "type" : "string" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents metadata for an admin account to be invited" }, "description" : "Represents metadata for an admin account to be invited" }, "roles" : { "type" : "array", "description" : "Represents the role IDs for an admin account to be invited", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_AccountInvitationDetails" } } } }, "AdminAccountInvitationResponse_Account" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "id" : { "type" : "string" }, "sent" : { "type" : "string", "format" : "date-time" }, "validUntil" : { "type" : "string", "format" : "date-time" } } }, "AdminAccountInvitationResponse_AccountInvitationDetails" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "email" : { "type" : "string" }, "id" : { "type" : "string" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountRole_AccountInvitationDetails" } }, "sent" : { "type" : "string", "format" : "date-time" }, "validUntil" : { "type" : "string", "format" : "date-time" } } }, "AdminAdaptiveAccessPolicyResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "accountLockout" : { "$ref" : "#/components/schemas/AccountLockoutResponse_AdaptiveMFA" }, "exposeAttempts" : { "type" : "boolean" }, "externalLoginsMFAEnabled" : { "type" : "boolean" }, "mfa" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyMFAResponse_AdaptiveMFA" }, "rules" : { "$ref" : "#/components/schemas/RulesResponse_AdaptiveMFA" }, "sessionTermination" : { "$ref" : "#/components/schemas/SessionTerminationResponse_AdaptiveMFA" }, "workflow" : { "type" : "array", "description" : "Defines each step in the login flow to be performed in a specific order", "items" : { "type" : "string" } } } }, "AdminAdaptiveAccessPolicyUpdateRequest_AdaptiveMFA" : { "required" : [ "mfa", "workflow" ], "type" : "object", "properties" : { "accountLockout" : { "$ref" : "#/components/schemas/AccountLockout_AdaptiveMFA" }, "exposeAttempts" : { "type" : "boolean", "default" : false }, "externalLoginsMFAEnabled" : { "type" : "boolean", "default" : false }, "mfa" : { "$ref" : "#/components/schemas/MfaRequest_AdaptiveMFA" }, "rules" : { "$ref" : "#/components/schemas/RulesRequest_AdaptiveMFA" }, "sessionTermination" : { "$ref" : "#/components/schemas/SessionTermination_AdaptiveMFA" }, "workflow" : { "type" : "array", "description" : "Defines each step in the login flow to be performed in a specific order", "example" : [ "username", "mfa", "password" ], "items" : { "type" : "string", "description" : "Represents a step in the login flow", "enum" : [ "username", "password", "mfa" ] }, "enum" : [ "[\"username\", \"mfa\", \"password\"]", "[\"username\", \"password\", \"mfa\"]", "[\"username\", \"mfa\"]", "[\"username\", \"password\"]" ] } } }, "AdminApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "application" : { "$ref" : "#/components/schemas/NameAndId_ApiAccessPolicy" }, "client" : { "$ref" : "#/components/schemas/NameAndId_ApiAccessPolicy" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeResponse_ApiAccessPolicy" } } } }, "AdminAppleLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderConfiguration" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "loginButtonText" : { "type" : "string" }, "name" : { "type" : "string" }, "onlyStoreMappedValues" : { "type" : "boolean" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean" } } }, "AdminAppleLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string" }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminAppleLoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminBrandingCustomCss_Brand" : { "type" : "object", "properties" : { "adminPortal" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "CSS code for custom styling on admin portal" }, "login" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "CSS code for custom styling on login flow" }, "myaccount" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "CSS code for custom styling on myaccount" } } }, "AdminBranding_Brand" : { "required" : [ "backgroundColor", "primaryColor" ], "type" : "object", "properties" : { "backgroundColor" : { "pattern" : "#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?", "type" : "string", "description" : "Represented in a hexadecimal format, optionally extended with an alpha channel." }, "copyright" : { "type" : "string" }, "css" : { "$ref" : "#/components/schemas/AdminBrandingCustomCss_Brand" }, "faviconUrl" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "primaryColor" : { "pattern" : "#[0-9a-fA-F]{6}([0-9a-fA-F]{2})?", "type" : "string", "description" : "Represented in a hexadecimal format, optionally extended with an alpha channel." }, "privacyPolicyUrl" : { "maxLength" : 1024, "minLength" : 10, "type" : "string" }, "siteTermsUrl" : { "maxLength" : 1024, "minLength" : 10, "type" : "string" } }, "description" : "Represents a branding for the admin portal" }, "AdminGenericLoginProviderRequest" : { "type" : "object", "description" : "Represents an external login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/AdminAppleLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/AdminSocialLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/AdminOidcSpecializedLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/AdminOidcLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/AdminSaml2LoginProviderUpsertRequest" } ] }, "AdminGenericLoginProviderRequest_InsertRequest" : { "type" : "object", "description" : "Represents an external login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/AdminAppleLoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/AdminSocialLoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/AdminOidcSpecializedLoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/AdminOidcLoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/AdminSaml2LoginProvider_InsertRequest" } ] }, "AdminGenericLoginProviderResponse" : { "type" : "object", "description" : "Represents an admin external login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/AdminAppleLoginProviderResponse" }, { "$ref" : "#/components/schemas/AdminSocialLoginProviderResponse" }, { "$ref" : "#/components/schemas/AdminSaml2LoginProviderResponse" }, { "$ref" : "#/components/schemas/AdminOidcSpecializedLoginProviderResponse" }, { "$ref" : "#/components/schemas/AdminOidcLoginProviderResponse" } ] }, "AdminNotificationPolicyResponse" : { "type" : "object", "properties" : { "sender" : { "type" : "string" } } }, "AdminNotificationPolicyUpdateRequest" : { "required" : [ "sender" ], "type" : "object", "properties" : { "sender" : { "maxLength" : 64, "minLength" : 0, "pattern" : "([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\")(\\.([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\"))*", "type" : "string" } } }, "AdminOidcLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcConfiguration" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "loginButtonText" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "name" : { "type" : "string" }, "onlyStoreMappedValues" : { "type" : "boolean" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean" } } }, "AdminOidcLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string" }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "logoUrl" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminOidcLoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "logoUrl" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminOidcSpecializedLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedConfiguration" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "loginButtonText" : { "type" : "string" }, "name" : { "type" : "string" }, "onlyStoreMappedValues" : { "type" : "boolean" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean" } } }, "AdminOidcSpecializedLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string" }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminOidcSpecializedLoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminRoleResponse_AdminRole" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "AdminRoleUpsertRequest_AdminRole" : { "required" : [ "id", "name", "scopes" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "AdminRole_InsertRequest" : { "required" : [ "name", "scopes" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "AdminSaml2LoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderConfiguration" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "loginButtonText" : { "type" : "string" }, "name" : { "type" : "string" }, "onlyStoreMappedValues" : { "type" : "boolean" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean" } } }, "AdminSaml2LoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string" }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminSaml2LoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminSocialLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderConfiguration" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "loginButtonText" : { "type" : "string" }, "name" : { "type" : "string" }, "onlyStoreMappedValues" : { "type" : "boolean" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean" } } }, "AdminSocialLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string" }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "AdminSocialLoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : true }, "loginButtonText" : { "maxLength" : 32, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 2, "pattern" : "[a-zA-Z0-9]+", "type" : "string", "description" : "This field cannot be altered" }, "onlyStoreMappedValues" : { "type" : "boolean", "default" : false }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] }, "updateAccountInfoOnLogin" : { "type" : "boolean", "default" : false } } }, "ApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApiAccessPolicy" }, "application" : { "$ref" : "#/components/schemas/NameAndId_ApiAccessPolicy" }, "client" : { "$ref" : "#/components/schemas/NameAndId_ApiAccessPolicy" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeResponse_ApiAccessPolicy" } } } }, "ApiSecurityPolicyAssignmentUpsertRequest_ApiAccessPolicy" : { "required" : [ "apiAccessPolicy", "client", "scopes" ], "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApiAccessPolicy" }, "client" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApiAccessPolicy" }, "scopes" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApiAccessPolicy" } } } }, "ApiSecurityPolicyResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "assignments" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" } }, "audience" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ScopeResponse_ApiAccessPolicy" } } } }, "AppleLoginProviderConfiguration" : { "type" : "object", "properties" : { "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "type" : "string" }, "keyId" : { "type" : "string" }, "signingKey" : { "type" : "string" }, "teamId" : { "type" : "string" } } }, "AppleLoginProviderRequestConfiguration" : { "required" : [ "claims", "clientId", "keyId", "signingKey", "teamId" ], "type" : "object", "properties" : { "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "keyId" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "signingKey" : { "maxLength" : 2048, "minLength" : 50, "type" : "string" }, "teamId" : { "maxLength" : 256, "minLength" : 1, "type" : "string" } } }, "AuthenticatorAdminInsertRequest_Account" : { "required" : [ "target", "type" ], "type" : "object", "properties" : { "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "publicMetadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "subType" : { "type" : "string", "description" : "ID of subtype" }, "target" : { "type" : "string", "description" : "Targeted email address or phone number the MFA request is sent to" }, "type" : { "type" : "string", "enum" : [ "email", "phone", "custom" ] } } }, "AuthenticatorResponse_Account" : { "type" : "object", "properties" : { "createdAt" : { "type" : "string", "description" : "Creation time of the authenticator", "format" : "date-time" }, "id" : { "type" : "string" }, "lastUsedAt" : { "type" : "string", "description" : "Last usage time of the authenticator", "format" : "date-time" }, "methods" : { "type" : "array", "items" : { "type" : "string", "description" : "Authenticator method that defines how the authentication can be done. Possible values: `passcode`, `magicLink`, `voice` and `publicKey`.", "example" : "passcode" } }, "publicMetadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Authenticator public metadata" }, "description" : "Authenticator public metadata" }, "subType" : { "type" : "string", "description" : "ID of Additional factor used for MFA" }, "target" : { "type" : "string", "description" : "Authenticator target, to where the MFA will be requested for", "example" : "+36301234567" }, "type" : { "type" : "string", "description" : "Authenticator type used for MFA", "enum" : [ "phone", "email", "softToken", "webAuthnSecurityKey", "webAuthnDeviceBiometrics", "passkey", "custom" ] } }, "description" : "Represents an authenticator for an account" }, "AuthenticatorsResponse_Account" : { "type" : "object", "properties" : { "methods" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuthenticatorResponse_Account" } } }, "description" : "Represents the authenticators for an account" }, "BehaviorAnalyticsResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "useLocation" : { "type" : "boolean" }, "useTime" : { "type" : "boolean" } }, "description" : "Configuration of behavior analytics" }, "BehaviorAnalytics_AdaptiveMFA" : { "type" : "object", "properties" : { "useLocation" : { "type" : "boolean", "default" : false }, "useTime" : { "type" : "boolean", "default" : false } }, "description" : "Defines rules to use machine learning for step down rules" }, "BlockingRulesRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "anonymousProxy" : { "type" : "boolean", "default" : false }, "botDetectionLevel" : { "type" : "string", "default" : "off", "enum" : [ "off", "low", "high" ] }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressRequest_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationRequest_AdaptiveMFA" } }, "description" : "Defines when to block login and registration by a set of rules" }, "BlockingRulesResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "anonymousProxy" : { "type" : "boolean" }, "botDetectionLevel" : { "type" : "string", "enum" : [ "off", "low", "high" ] }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressResponse_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationResponse_AdaptiveMFA" } }, "description" : "Defines when to block login and registration by a set of rules" }, "CheckboxAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a checkbox type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "default" : { "type" : "boolean", "default" : false } } } ] }, "ConfigurationResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "maxFailedAttempts" : { "type" : "integer", "format" : "int32" } }, "description" : "Session termination settings response" }, "ConsentResponse_Account" : { "type" : "object", "properties" : { "consentId" : { "type" : "string" }, "consentVersion" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "string" }, "optIn" : { "type" : "string", "format" : "date-time" }, "optOut" : { "type" : "string", "format" : "date-time" } } }, "CustomMfaInsertRequest_CustomMfa" : { "required" : [ "methods", "name", "packageDependencies" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the custom mfa, if not specified it's generated automatically for each type", "default" : "*example code*" }, "description" : { "type" : "string" }, "iconUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "methods" : { "maxItems" : 1, "minItems" : 1, "type" : "array", "items" : { "pattern" : "^(passcode|magicLink)$", "type" : "string" } }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" } } }, "CustomMfaListResponse_CustomMfa" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "iconUrl" : { "type" : "string" }, "id" : { "type" : "string" }, "methods" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string" } } }, "CustomMfaResponse_CustomMfa" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "description" : { "type" : "string" }, "iconUrl" : { "type" : "string" }, "id" : { "type" : "string" }, "methods" : { "type" : "array", "items" : { "type" : "string" } }, "name" : { "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "CustomMfaUpdateRequest_CustomMfa" : { "required" : [ "id", "methods", "name", "packageDependencies" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the custom mfa, if not specified it's generated automatically for each type", "default" : "*example code*" }, "description" : { "type" : "string" }, "iconUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "id" : { "type" : "string" }, "methods" : { "maxItems" : 1, "minItems" : 1, "type" : "array", "items" : { "pattern" : "^(passcode|magicLink)$", "type" : "string" } }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" } } }, "DateAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "renderType", "type" ], "type" : "object", "description" : "Represents a date type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "renderType" : { "type" : "string", "description" : "Defines how a date input field should be rendered. When set to `native`, the date picker appears as the browser default, `fieldSet` is ensuring that the year, month and day fields are separate inputs.", "enum" : [ "native", "fieldSet" ] }, "validator" : { "$ref" : "#/components/schemas/DateValidator_AccountAttribute" } } } ] }, "DateValidator_AccountAttribute" : { "type" : "object", "properties" : { "notAfter" : { "type" : "string", "description" : "Default value is null", "format" : "date" }, "notAfterRelativeDays" : { "type" : "integer", "description" : "Default value is null", "format" : "int32" }, "notBefore" : { "type" : "string", "description" : "Default value is null", "format" : "date" }, "notBeforeRelativeDays" : { "type" : "integer", "description" : "Default value is null", "format" : "int32" } }, "description" : "Represents a date validator" }, "Detail" : { "type" : "object", "properties" : { "label" : { "type" : "string" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "name" : { "type" : "string" }, "notifications" : { "type" : "array", "items" : { "type" : "string" } }, "outcome" : { "type" : "string" }, "timestamp" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string" } }, "description" : "Represents the details of an event" }, "DisplayNameAndIdResponse" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "id" : { "type" : "string" } } }, "EventActor" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "bulkJobId" : { "type" : "string" }, "ip" : { "type" : "string" }, "location" : { "$ref" : "#/components/schemas/FeatureResponse" }, "ruleId" : { "type" : "string" }, "store" : { "type" : "string", "description" : "Name of the represented identity store" }, "userAgent" : { "type" : "string", "description" : "Information about the browser the actor used" }, "userName" : { "type" : "string", "description" : "Username or email of the actor (email for email-only identity stores)" } }, "description" : "Actor of the event, which account initiated the event" }, "ExternalLoginMappingResponse" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "fieldValueRegex" : { "type" : "string" }, "id" : { "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" }, "sourcePath" : { "type" : "string" } } }, "ExternalLoginMappingUpsertRequest" : { "required" : [ "id", "nativeClaim", "sourcePath" ], "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "fieldValueRegex" : { "type" : "string" }, "id" : { "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "sourcePath" : { "maxLength" : 256, "minLength" : 0, "type" : "string" } } }, "ExternalLoginProviderReferenceResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" }, "name" : { "type" : "string", "description" : "Name of the represented entity", "example" : "Entity name" }, "type" : { "type" : "string", "enum" : [ "oidc", "okta", "azure", "hypr", "saml2", "github", "microsoft", "google", "facebook", "twitter", "linkedin", "amazon", "apple" ] } } }, "ExternalLogin_Mapping_InsertRequest" : { "required" : [ "nativeClaim", "sourcePath" ], "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "fieldValueRegex" : { "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "sourcePath" : { "maxLength" : 256, "minLength" : 0, "type" : "string" } } }, "FactorRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "mandatory" : { "type" : "boolean", "default" : false } }, "description" : "Represents a factor used for MFA" }, "FactorResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "mandatory" : { "type" : "boolean" } }, "description" : "Represents a factor used for MFA" }, "FeatureResponse" : { "type" : "object", "properties" : { "geometry" : { "$ref" : "#/components/schemas/GeometryResponse" }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "type" : { "type" : "string" } }, "description" : "Represents a feature object according to the [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) standard" }, "FeatureResponse_Account" : { "type" : "object", "properties" : { "geometry" : { "$ref" : "#/components/schemas/GeometryResponse_Account" }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "type" : { "type" : "string" } }, "description" : "Represents a feature object according to the [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946#section-3.2) standard" }, "FieldError" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" }, "objectName" : { "type" : "string" } } }, "FieldError_AccountInvitationDetails" : { "type" : "object", "properties" : { "field" : { "type" : "string" }, "message" : { "type" : "string" }, "objectName" : { "type" : "string" } } }, "FrontendHook_AccountAttribute" : { "type" : "object", "properties" : { "code" : { "maxLength" : 32000, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false } }, "description" : "Represents a frontend hook" }, "GeometryResponse" : { "type" : "object", "properties" : { "coordinates" : { "type" : "array", "items" : { "type" : "number", "format" : "double" } }, "type" : { "type" : "string" } }, "description" : "Represents a geometry object according to the [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946#section-3.1) standard" }, "GeometryResponse_Account" : { "type" : "object", "properties" : { "coordinates" : { "type" : "array", "items" : { "type" : "number", "format" : "double" } }, "type" : { "type" : "string" } }, "description" : "Represents a geometry object according to the [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946#section-3.1) standard" }, "Http" : { "type" : "object", "properties" : { "request" : { "$ref" : "#/components/schemas/Request" }, "response" : { "$ref" : "#/components/schemas/Response" } }, "description" : "Represents the HTTP communication for an event" }, "IdReferenceRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_Account" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_AccountInvitationDetails" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_AdaptiveMFA" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_ApiAccessPolicy" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "IdentifiedSessionResponse_Account" : { "type" : "object", "properties" : { "deviceString" : { "type" : "string" }, "id" : { "type" : "string" }, "lastIP" : { "type" : "string" }, "lastLoginAt" : { "type" : "string", "format" : "date-time" }, "location" : { "$ref" : "#/components/schemas/FeatureResponse_Account" }, "userAgent" : { "type" : "string" } } }, "IdentifierAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "type" ], "type" : "object", "description" : "Represents an identifier type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "displayOnInvitation" : { "type" : "boolean", "default" : false }, "requiredOnAdminConsole" : { "type" : "boolean", "default" : false }, "requiredOnInvitation" : { "type" : "boolean", "default" : false }, "requiredOnOrganizationPortal" : { "type" : "boolean", "default" : false }, "requiredOnRegistration" : { "type" : "boolean", "default" : false } } } ] }, "IdentitiesResponse.Email_Account" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents the email identifier" }, "verified" : { "type" : "boolean" } } }, "IdentitiesResponse.Email_Identities" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents the email identifier" }, "verified" : { "type" : "boolean" } } }, "IdentitiesResponse.External_Account" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents an external identifier" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "IdentitiesResponse.External_Identities" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents an external identifier" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "IdentitiesResponse.Local_Account" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents the username identifier" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents metadata for account information" }, "description" : "Represents metadata for account information" } }, "description" : "Represents the local metadata for an account" }, "IdentitiesResponse.Local_Identities" : { "type" : "object", "properties" : { "display" : { "type" : "string" }, "id" : { "type" : "string", "description" : "Represents the username identifier" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents metadata for account information" }, "description" : "Represents metadata for account information" } }, "description" : "Represents the local metadata for an account" }, "IdentitiesResponse.Phone_Account" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Represents the phone identifier" }, "verified" : { "type" : "boolean" } } }, "IdentitiesResponse.Phone_Identities" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Represents the phone identifier" }, "verified" : { "type" : "boolean" } } }, "IdentitiesResponse_Account" : { "type" : "object", "description" : "Represents the identities of an account", "oneOf" : [ { "$ref" : "#/components/schemas/IdentitiesResponse.Local_Account" }, { "$ref" : "#/components/schemas/IdentitiesResponse.Email_Account" }, { "$ref" : "#/components/schemas/IdentitiesResponse.Phone_Account" }, { "$ref" : "#/components/schemas/IdentitiesResponse.External_Account" } ] }, "IdentitiesResponse_Identities" : { "type" : "object", "description" : "Represents the identities of an account", "oneOf" : [ { "$ref" : "#/components/schemas/IdentitiesResponse.Local_Identities" }, { "$ref" : "#/components/schemas/IdentitiesResponse.Email_Identities" }, { "$ref" : "#/components/schemas/IdentitiesResponse.Phone_Identities" }, { "$ref" : "#/components/schemas/IdentitiesResponse.External_Identities" } ] }, "InvitationConflictProblemJson_AccountInvitationDetails" : { "type" : "object", "properties" : { "conflictingId" : { "type" : "string" }, "detail" : { "type" : "string" }, "entityName" : { "type" : "string", "description" : "The name of the entity within the error has occurred" }, "errorKey" : { "type" : "string", "description" : "A unique identifier of the error" }, "fieldErrors" : { "type" : "array", "description" : "Field constraint violation errors", "items" : { "$ref" : "#/components/schemas/FieldError_AccountInvitationDetails" } }, "message" : { "type" : "string", "description" : "A unique identifier in format of 'error.{errorKey}'" }, "params" : { "type" : "array", "description" : "Further information related to the actual error", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } }, "path" : { "type" : "string", "description" : "Request URI" }, "status" : { "type" : "integer", "description" : "Status code", "format" : "int32" }, "title" : { "type" : "string" } } }, "IpAddressRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Represents a type of inclusion", "default" : "include", "enum" : [ "include", "exclude" ] }, "values" : { "type" : "array", "description" : "Represents a list of subnet ranges (CIDR). See: [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632)", "items" : { "type" : "string", "example" : "1.1.1.1/32" }, "default" : [ ] } }, "description" : "IP address rules to be used for an adaptive access policy" }, "IpAddressResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "Represents a type of inclusion", "enum" : [ "include", "exclude" ] }, "values" : { "type" : "array", "description" : "Represents a list of IP addresses", "items" : { "type" : "string" } } }, "description" : "Configuration of including or excluding a list of IP addresses" }, "LastLoginResponse_Account" : { "type" : "object", "properties" : { "ip" : { "type" : "string" }, "location" : { "$ref" : "#/components/schemas/FeatureResponse_Account" }, "time" : { "type" : "string", "format" : "date-time" } }, "description" : "Represents the last login by IP address and time of login" }, "LocationResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "city" : { "type" : "string" }, "country" : { "type" : "string" }, "state" : { "type" : "string" } } }, "LocationValueRequest_AdaptiveMFA" : { "required" : [ "country" ], "type" : "object", "properties" : { "city" : { "type" : "string" }, "country" : { "type" : "string" }, "state" : { "type" : "string" } }, "description" : "Represents a location by its regional properties" }, "LocationValueResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "city" : { "type" : "string" }, "country" : { "type" : "string" }, "state" : { "type" : "string" } }, "description" : "Represents a location by its regional properties" }, "LockoutResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "permanent" : { "$ref" : "#/components/schemas/PermanentLockoutResponse_AdaptiveMFA" }, "temporary" : { "$ref" : "#/components/schemas/TemporaryLockoutResponse_AdaptiveMFA" } }, "description" : "Represents lockout settings." }, "Lockout_AdaptiveMFA" : { "required" : [ "permanent", "temporary" ], "type" : "object", "properties" : { "permanent" : { "$ref" : "#/components/schemas/PermanentLockout_AdaptiveMFA" }, "temporary" : { "$ref" : "#/components/schemas/TemporaryLockout_AdaptiveMFA" } }, "description" : "Account lockout settings" }, "MessageLevelEncryption" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "fingerprint" : { "type" : "string" } } }, "MessageLevelEncryptionRequest" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "privateKey" : { "maxLength" : 8192, "minLength" : 1, "type" : "string" } } }, "MfaRequest_AdaptiveMFA" : { "required" : [ "email", "phone", "softToken" ], "type" : "object", "properties" : { "customMfaAssignments" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_AdaptiveMFA" } }, "email" : { "$ref" : "#/components/schemas/OutOfBandFactorRequest_AdaptiveMFA" }, "enforceSecondFactor" : { "type" : "boolean", "default" : false }, "magicLinkLifetimeMinutes" : { "maximum" : 30, "minimum" : 1, "type" : "integer", "format" : "int32" }, "passcodeLength" : { "maximum" : 8, "minimum" : 6, "type" : "integer", "format" : "int32" }, "passcodeLifetimeMinutes" : { "maximum" : 30, "minimum" : 1, "type" : "integer", "format" : "int32" }, "passkey" : { "$ref" : "#/components/schemas/PasskeyFactorRequest_AdaptiveMFA" }, "phone" : { "$ref" : "#/components/schemas/OutOfBandFactorRequest_AdaptiveMFA" }, "skipAuthenticatorSelectEnrollScreen" : { "type" : "boolean", "default" : false }, "skipMethodSelectionEnabled" : { "type" : "boolean", "default" : false }, "softToken" : { "$ref" : "#/components/schemas/SoftTokenFactorRequest_AdaptiveMFA" }, "webAuthnDeviceBiometrics" : { "$ref" : "#/components/schemas/FactorRequest_AdaptiveMFA" }, "webAuthnSecurityKey" : { "$ref" : "#/components/schemas/FactorRequest_AdaptiveMFA" } } }, "NameAndColorResponse" : { "type" : "object", "properties" : { "color" : { "type" : "string", "description" : "Color in hexadecimal format" }, "name" : { "type" : "string" } } }, "NameAndId_ApiAccessPolicy" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameIdAndDisplayName" : { "type" : "object", "properties" : { "displayName" : { "type" : "string", "description" : "Display name of the represented entity" }, "id" : { "type" : "string", "description" : "ID of the represented entity" }, "name" : { "type" : "string", "description" : "Name of the represented entity" } } }, "NativeClaimResponse_NativeClaim" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "dialectUri" : { "type" : "string" }, "displayName" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "readonly" : { "type" : "boolean" } } }, "NativeClaim_AccountAttribute" : { "required" : [ "displayName", "id", "name" ], "type" : "object", "properties" : { "displayName" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z][a-zA-Z0-9_!#$&'()*+,\\/:;=?@\\[\\].]*$", "type" : "string" } } }, "NotificationEventListResponse" : { "type" : "object", "properties" : { "accountEventId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "channel" : { "type" : "string" }, "id" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "invitationId" : { "type" : "string" }, "notificationPolicyId" : { "type" : "string" }, "notificationTemplate" : { "$ref" : "#/components/schemas/DisplayNameAndIdResponse" }, "target" : { "type" : "string" }, "timestamp" : { "type" : "string" }, "validUntil" : { "type" : "string" } }, "description" : "Represents a notification event briefly. Fields with empty values are not included in the response." }, "NotificationEventResponse" : { "type" : "object", "properties" : { "accountEventId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "channel" : { "type" : "string" }, "id" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "invitationId" : { "type" : "string" }, "message" : { "type" : "string" }, "messagePlainText" : { "type" : "string" }, "notificationPolicyId" : { "type" : "string" }, "notificationTemplate" : { "$ref" : "#/components/schemas/DisplayNameAndIdResponse" }, "target" : { "type" : "string" }, "timestamp" : { "type" : "string" }, "validUntil" : { "type" : "string" } }, "description" : "Represents a notification event. Fields with empty values are not included in the response." }, "NotificationTemplateDTO_NotificationTemplate" : { "required" : [ "id" ], "type" : "object", "properties" : { "body" : { "maxLength" : 100000, "minLength" : 1, "type" : "string", "description" : "HTML body of the template, if not specified it'll be reset to the default template" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" }, "type" : { "type" : "string", "enum" : [ "sms", "email" ] } } }, "NotificationTemplateEmailUpdateRequest_NotificationTemplate" : { "required" : [ "id" ], "type" : "object", "properties" : { "body" : { "maxLength" : 100000, "minLength" : 1, "type" : "string", "description" : "HTML body of the template, if not specified it'll be reset to the default template" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" }, "plainTextBody" : { "maxLength" : 100000, "minLength" : 1, "type" : "string", "description" : "Plain text body of the template, if not specified it'll be reset to the default template" }, "subject" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string", "description" : "Subject text of the template, if not specified it'll be reset to the default template" }, "type" : { "type" : "string", "enum" : [ "sms", "email" ] } } }, "NotificationTemplateResponse_NotificationTemplateMetainfo" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "modified" : { "type" : "boolean" }, "optional" : { "type" : "boolean" }, "placeholders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Placeholder_NotificationTemplateMetainfo" } } }, "description" : "Represents a notification template" }, "NotificationTemplateSMSUpdateRequest_NotificationTemplate" : { "required" : [ "id" ], "type" : "object", "properties" : { "body" : { "maxLength" : 100000, "minLength" : 1, "type" : "string", "description" : "HTML body of the template, if not specified it'll be reset to the default template" }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "maxLength" : 255, "minLength" : 0, "pattern" : "^[a-zA-Z0-9-_]+$", "type" : "string" }, "type" : { "type" : "string", "enum" : [ "sms", "email" ] } } }, "OidcConfiguration" : { "type" : "object", "properties" : { "acrValue" : { "type" : "string" }, "authorizationEndpoint" : { "type" : "string" }, "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" }, "issuer" : { "type" : "string" }, "jwksUri" : { "type" : "string" }, "messageLevelEncryption" : { "$ref" : "#/components/schemas/MessageLevelEncryption" }, "openIdAutoDiscoveryURL" : { "type" : "string" }, "tokenEndpoint" : { "type" : "string" }, "tokenEndpointAuthMethodOverride" : { "type" : "string", "enum" : [ "client_secret_basic", "client_secret_post" ] }, "userInfoEndpoint" : { "type" : "string" } } }, "OidcLoginProviderRequestConfiguration" : { "required" : [ "claims", "clientId", "clientSecret" ], "type" : "object", "properties" : { "acrValue" : { "maxLength" : 8192, "minLength" : 1, "type" : "string" }, "authorizationEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "clientSecret" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "issuer" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "jwksUri" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "messageLevelEncryption" : { "$ref" : "#/components/schemas/MessageLevelEncryptionRequest" }, "openIdAutoDiscoveryURL" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "tokenEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "tokenEndpointAuthMethodOverride" : { "type" : "string", "description" : "Sets or overrides token endpoint authentication method of Auto-discovery config.\nOptions:\n(1) null - use settings from auto-discovery, fallback to Basic if no auto-discovery\n(2) client_secret_basic - client ID and secret sent in authorization header\n(3) client_secret_post - client ID and secret sent in body of request\n", "enum" : [ "client_secret_basic", "client_secret_post" ] }, "userInfoEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" } } }, "OidcSpecializedConfiguration" : { "type" : "object", "properties" : { "acrValue" : { "type" : "string" }, "authorizationEndpoint" : { "type" : "string" }, "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" }, "issuer" : { "type" : "string" }, "jwksUri" : { "type" : "string" }, "openIdAutoDiscoveryURL" : { "type" : "string" }, "tokenEndpoint" : { "type" : "string" }, "tokenEndpointAuthMethodOverride" : { "type" : "string", "enum" : [ "client_secret_basic", "client_secret_post" ] }, "userInfoEndpoint" : { "type" : "string" } } }, "OidcSpecializedLoginProviderRequestConfiguration" : { "required" : [ "claims", "clientId", "clientSecret" ], "type" : "object", "properties" : { "acrValue" : { "maxLength" : 8192, "minLength" : 1, "type" : "string" }, "authorizationEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "clientSecret" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "issuer" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "jwksUri" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "openIdAutoDiscoveryURL" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "tokenEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "tokenEndpointAuthMethodOverride" : { "type" : "string", "description" : "Sets or overrides token endpoint authentication method of Auto-discovery config.\nOptions:\n(1) null - use settings from auto-discovery, fallback to Basic if no auto-discovery\n(2) client_secret_basic - client ID and secret sent in authorization header\n(3) client_secret_post - client ID and secret sent in body of request\n", "enum" : [ "client_secret_basic", "client_secret_post" ] }, "userInfoEndpoint" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" } } }, "OutOfBandFactorRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "magicLinkEnabled" : { "type" : "boolean", "default" : false }, "mandatory" : { "type" : "boolean", "default" : false }, "passcodeEnabled" : { "type" : "boolean", "default" : true }, "restrictedToExisting" : { "type" : "boolean", "default" : false } }, "description" : "Represents an out-of-band factor for MFA. At least `passcodeEnabled` or `magicLinkEnabled` must be true." }, "OutOfBandFactorResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "magicLinkEnabled" : { "type" : "boolean" }, "mandatory" : { "type" : "boolean" }, "passcodeEnabled" : { "type" : "boolean" }, "restrictedToExisting" : { "type" : "boolean" } }, "description" : "Represents an out-of-band factor for MFA. At least `passcodeEnabled` or `magicLinkEnabled` must be true." }, "PageAdminRoleResponse_AdminRole" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdminRoleResponse_AdminRole" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_AdminRole" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageExternalLoginMappingResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExternalLoginMappingResponse" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageOfExternalLoginProviderNameAndIdAndType" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExternalLoginProviderReferenceResponse" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageOfGenericLoginProviderResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdminGenericLoginProviderResponse" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageOfNameAndColorResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NameAndColorResponse" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageOfPolicyTagResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PolicyTagResponse" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageableObject" : { "type" : "object", "properties" : { "offset" : { "type" : "integer", "format" : "int64" }, "pageNumber" : { "type" : "integer", "format" : "int32" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "paged" : { "type" : "boolean" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "unpaged" : { "type" : "boolean" } } }, "PageableObject_AdminRole" : { "type" : "object", "properties" : { "offset" : { "type" : "integer", "format" : "int64" }, "pageNumber" : { "type" : "integer", "format" : "int32" }, "pageSize" : { "type" : "integer", "format" : "int32" }, "paged" : { "type" : "boolean" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "unpaged" : { "type" : "boolean" } } }, "PasskeyFactorRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "PasskeyFactorResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "PasswordAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "id", "type" ], "type" : "object", "description" : "Represents an password type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" } ] }, "PasswordResetRequest_Account" : { "required" : [ "newPassword" ], "type" : "object", "properties" : { "newPassword" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "skipPasswordPolicy" : { "type" : "boolean" } }, "description" : "Contains the new password for a password reset" }, "PermanentLockoutResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "maxFailedAttempts" : { "type" : "integer", "format" : "int32" } }, "description" : "Represents permanent lockout settings." }, "PermanentLockout_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "maxFailedAttempts" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "format" : "int32" } } }, "PhoneNumberAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a phone number type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" } ] }, "Placeholder_NotificationTemplateMetainfo" : { "type" : "object", "properties" : { "placeholder" : { "type" : "string" } }, "description" : "Represents a placeholder" }, "PolicyTagResponse" : { "type" : "object", "properties" : { "color" : { "type" : "string", "description" : "Color in hexadecimal format" }, "description" : { "type" : "string" }, "name" : { "type" : "string" } } }, "PolicyTagUpsertRequest" : { "required" : [ "color", "name" ], "type" : "object", "properties" : { "color" : { "pattern" : "#[0-9a-fA-F]{6}", "type" : "string", "description" : "Color in hexadecimal format", "example" : "#ffffff" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "name" : { "maxLength" : 32, "minLength" : 2, "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string" } } }, "ProblemJson" : { "type" : "object", "properties" : { "detail" : { "type" : "string" }, "entityName" : { "type" : "string", "description" : "The name of the entity within the error has occurred" }, "errorKey" : { "type" : "string", "description" : "A unique identifier of the error" }, "fieldErrors" : { "type" : "array", "description" : "Field constraint violation errors", "items" : { "$ref" : "#/components/schemas/FieldError" } }, "message" : { "type" : "string", "description" : "A unique identifier in format of 'error.{errorKey}'" }, "params" : { "type" : "array", "description" : "Further information related to the actual error", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } }, "path" : { "type" : "string", "description" : "Request URI" }, "status" : { "type" : "integer", "description" : "Status code", "format" : "int32" }, "title" : { "type" : "string" } }, "description" : "Based on [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807)" }, "RememberMyDeviceRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true }, "enabledByDefault" : { "type" : "boolean", "default" : true }, "numberOfDays" : { "maximum" : 365, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 30 } }, "description" : "Device recognition rules to be used for an adaptive access policy" }, "RememberMyDeviceResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "enabledByDefault" : { "type" : "boolean" }, "numberOfDays" : { "type" : "integer", "format" : "int32" } }, "description" : "Configuration of device recognition" }, "Request" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "method" : { "type" : "string" }, "url" : { "type" : "string" } }, "description" : "Represents the HTTP request for an event" }, "Response" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "code" : { "type" : "integer", "format" : "int32" }, "location" : { "type" : "string" } }, "description" : "Represents the HTTP response for an event" }, "RulesRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "blockingRules" : { "$ref" : "#/components/schemas/BlockingRulesRequest_AdaptiveMFA" }, "stepDownRules" : { "$ref" : "#/components/schemas/StepDownRulesRequest_AdaptiveMFA" }, "stepUpRules" : { "$ref" : "#/components/schemas/StepUpRulesRequest_AdaptiveMFA" } }, "description" : "Rules defined for an adaptive access policy" }, "RulesResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "blockingRules" : { "$ref" : "#/components/schemas/BlockingRulesResponse_AdaptiveMFA" }, "stepDownRules" : { "$ref" : "#/components/schemas/StepDownRulesResponse_AdaptiveMFA" }, "stepUpRules" : { "$ref" : "#/components/schemas/StepUpRulesResponse_AdaptiveMFA" } }, "description" : "Configuration of different rules under an adaptive access policy" }, "Saml2LoginProviderConfiguration" : { "type" : "object", "properties" : { "allowIdpInitiated" : { "type" : "boolean" }, "authnNameIDFormat" : { "type" : "string", "enum" : [ "EmailAddressNameIDFormat", "PersistentNameIDFormat" ] }, "entityID" : { "type" : "string" }, "forceAuthn" : { "type" : "boolean" }, "idpMetadataUrl" : { "type" : "string" }, "metadataPreview" : { "$ref" : "#/components/schemas/Saml2LoginProviderConfigurationMetadataPreview" }, "protocolBinding" : { "type" : "string", "enum" : [ "HTTPPostBinding", "HTTPRedirectBinding" ] } } }, "Saml2LoginProviderConfigurationCertificatePreview" : { "type" : "object", "properties" : { "notAfter" : { "type" : "string" }, "subject" : { "type" : "string" } } }, "Saml2LoginProviderConfigurationMetadataPreview" : { "type" : "object", "properties" : { "certificates" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/Saml2LoginProviderConfigurationCertificatePreview" } }, "idpEntityID" : { "type" : "string" }, "singleSignOnServiceList" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Saml2LoginProviderConfigurationSingleSignOnService" } }, "validUntil" : { "type" : "string" } } }, "Saml2LoginProviderConfigurationSingleSignOnService" : { "type" : "object", "properties" : { "binding" : { "type" : "string" }, "location" : { "type" : "string" } } }, "Saml2LoginProviderRequestConfiguration" : { "required" : [ "authnNameIDFormat", "entityID", "protocolBinding" ], "type" : "object", "properties" : { "allowIdpInitiated" : { "type" : "boolean" }, "authnNameIDFormat" : { "type" : "string", "enum" : [ "EmailAddressNameIDFormat", "PersistentNameIDFormat" ] }, "entityID" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "forceAuthn" : { "type" : "boolean", "default" : false }, "idpMetadataUrl" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "metadata" : { "type" : "string" }, "protocolBinding" : { "type" : "string", "enum" : [ "HTTPPostBinding", "HTTPRedirectBinding" ] } } }, "ScopeAdminResponse_AdminRole" : { "type" : "object", "properties" : { "category" : { "type" : "string" }, "delete" : { "type" : "string", "description" : "Scope to delete the specified entity. The field is missing when there is no such scope." }, "name" : { "type" : "string" }, "read" : { "type" : "string", "description" : "Scope to read the specified entity. The field is missing when there is no such scope." }, "write" : { "type" : "string", "description" : "Scope to write the specified entity. The field is missing when there is no such scope." } } }, "ScopeResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "SelectAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a select type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "default" : { "type" : "string" }, "renderType" : { "type" : "string", "description" : "Defines how a select input field should be rendered. When set to `native`, the select appears as the browser default, when set `radio` the select appears as radio buttons.", "default" : "native", "enum" : [ "native", "radio" ] }, "values" : { "type" : "array", "description" : "Defines the possible options to be selected on a select input field", "items" : { "$ref" : "#/components/schemas/SelectValue_AccountAttribute" } } } } ] }, "SelectValue_AccountAttribute" : { "required" : [ "displayName", "value" ], "type" : "object", "properties" : { "displayName" : { "maxLength" : 64, "minLength" : 1, "type" : "string" }, "value" : { "maxLength" : 64, "minLength" : 1, "type" : "string" } }, "description" : "Represents a select value" }, "SessionTerminationConfiguration_AdaptiveMFA" : { "type" : "object", "properties" : { "maxFailedAttempts" : { "maximum" : 10, "minimum" : 2, "type" : "integer", "format" : "int32" } }, "description" : "Session termination settings" }, "SessionTerminationResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "identifier" : { "$ref" : "#/components/schemas/ConfigurationResponse_AdaptiveMFA" }, "passcode" : { "$ref" : "#/components/schemas/ConfigurationResponse_AdaptiveMFA" }, "password" : { "$ref" : "#/components/schemas/ConfigurationResponse_AdaptiveMFA" } }, "description" : "Session termination settings response" }, "SessionTermination_AdaptiveMFA" : { "required" : [ "identifier", "passcode", "password" ], "type" : "object", "properties" : { "identifier" : { "$ref" : "#/components/schemas/SessionTerminationConfiguration_AdaptiveMFA" }, "passcode" : { "$ref" : "#/components/schemas/SessionTerminationConfiguration_AdaptiveMFA" }, "password" : { "$ref" : "#/components/schemas/SessionTerminationConfiguration_AdaptiveMFA" } }, "description" : "Represents the session termination configuration" }, "SocialLoginProviderConfiguration" : { "type" : "object", "properties" : { "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" } } }, "SocialLoginProviderRequestConfiguration" : { "required" : [ "claims", "clientId", "clientSecret" ], "type" : "object", "properties" : { "claims" : { "type" : "array", "items" : { "type" : "string" } }, "clientId" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "clientSecret" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" } } }, "SoftTokenFactorRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "label" : { "maxLength" : 255, "minLength" : 1, "type" : "string", "description" : "Display label used in soft token authenticator apps" }, "mandatory" : { "type" : "boolean", "default" : false } }, "description" : "Configuration of a soft token factor used for MFA" }, "SoftTokenFactorResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "label" : { "type" : "string" }, "mandatory" : { "type" : "boolean" } }, "description" : "Represents a soft token factor used for MFA" }, "SortObject" : { "type" : "object", "properties" : { "ascending" : { "type" : "boolean" }, "direction" : { "type" : "string" }, "ignoreCase" : { "type" : "boolean" }, "nullHandling" : { "type" : "string" }, "property" : { "type" : "string" } } }, "StepDownRulesRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "behaviorAnalytics" : { "$ref" : "#/components/schemas/BehaviorAnalytics_AdaptiveMFA" }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressRequest_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationRequest_AdaptiveMFA" }, "rememberMyDevice" : { "$ref" : "#/components/schemas/RememberMyDeviceRequest_AdaptiveMFA" } }, "description" : "Defines when to skip MFA for login by a set of rules" }, "StepDownRulesResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "behaviorAnalytics" : { "$ref" : "#/components/schemas/BehaviorAnalyticsResponse_AdaptiveMFA" }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressResponse_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationResponse_AdaptiveMFA" }, "rememberMyDevice" : { "$ref" : "#/components/schemas/RememberMyDeviceResponse_AdaptiveMFA" } }, "description" : "Defines when to skip MFA for login by a set of rules" }, "StepUpRulesRequest_AdaptiveMFA" : { "type" : "object", "properties" : { "anonymousProxy" : { "type" : "boolean", "default" : false }, "botDetectionLevel" : { "type" : "string", "default" : "low", "enum" : [ "off", "low", "high" ] }, "improbableTravelEventDetection" : { "type" : "boolean", "default" : false }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressRequest_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationRequest_AdaptiveMFA" } }, "description" : "Defines when to require MFA for login by a set of rules" }, "StepUpRulesResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "anonymousProxy" : { "type" : "boolean", "default" : false }, "botDetectionLevel" : { "type" : "string", "enum" : [ "off", "low", "high" ] }, "improbableTravelEventDetection" : { "type" : "boolean", "default" : false }, "ipAddress" : { "$ref" : "#/components/schemas/IpAddressResponse_AdaptiveMFA" }, "location" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyLocationResponse_AdaptiveMFA" } }, "description" : "Defines when to require MFA for login by a set of rules" }, "StringAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a string type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "autocomplete" : { "maxLength" : 64, "minLength" : 0, "type" : "string", "description" : "Provides automated assistance in filling out form field values" }, "default" : { "type" : "string" }, "validator" : { "$ref" : "#/components/schemas/StringValidator_AccountAttribute" } } } ] }, "StringValidator_AccountAttribute" : { "type" : "object", "properties" : { "errorMessage" : { "maxLength" : 512, "minLength" : 0, "type" : "string" }, "max" : { "maximum" : 10000, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 512 }, "min" : { "maximum" : 512, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 }, "regex" : { "maxLength" : 512, "minLength" : 0, "type" : "string" } }, "description" : "Represents a string validator" }, "Subject" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "store" : { "type" : "string", "description" : "Name of the identity store" }, "userName" : { "type" : "string" } }, "description" : "Represents the subject of an account event by additional context" }, "TagBasedPermissionInsertRequest" : { "required" : [ "policyTags", "scopes" ], "type" : "object", "properties" : { "policyTags" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string" } }, "scopes" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "TagBasedPermissionResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "policyTags" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "TagBasedPermissionUpdateRequest" : { "required" : [ "policyTags", "scopes" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "policyTags" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string" } }, "scopes" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "TemporaryLockoutResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "lockoutDurationMinutes" : { "type" : "integer", "format" : "int32" }, "maxFailedAttempts" : { "type" : "integer", "format" : "int32" } }, "description" : "Represents temporary lockout settings." }, "TemporaryLockout_AdaptiveMFA" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "lockoutDurationMinutes" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "format" : "int32" }, "maxFailedAttempts" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "format" : "int32" } } }, "UsernameIdentifierAttributeDTO_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" }, { "type" : "object", "properties" : { "displayOnInvitation" : { "type" : "boolean", "default" : false }, "requiredOnAdminConsole" : { "type" : "boolean", "default" : false }, "requiredOnInvitation" : { "type" : "boolean", "default" : false }, "requiredOnOrganizationPortal" : { "type" : "boolean", "default" : false }, "requiredOnRegistration" : { "type" : "boolean", "default" : false }, "validator" : { "$ref" : "#/components/schemas/UsernameIdentifierValidator_AccountAttribute" } } } ] }, "UsernameIdentifierValidator_AccountAttribute" : { "type" : "object", "properties" : { "errorMessage" : { "maxLength" : 512, "minLength" : 0, "type" : "string" }, "max" : { "maximum" : 256, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 104 }, "min" : { "maximum" : 256, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 1 }, "regex" : { "maxLength" : 512, "minLength" : 0, "type" : "string" } } } }, "securitySchemes" : { "securityScheme" : { "scheme" : "bearer", "type" : "http" } } } }