{ "openapi" : "3.0.1", "info" : { "description" : "API documentation of Admin Portal", "title" : "Admin Portal", "version" : "v0.0.1" }, "servers" : [ { "url" : "https://{tenant}", "variables" : { "tenant" : { "default" : "example.strivacity.com", "description" : "Your Strivacity tenant" } } } ], "tags" : [ { "name" : "Account" }, { "name" : "Account Attribute" }, { "name" : "Account Event" }, { "name" : "Account Event TTL" }, { "name" : "Account Identity" }, { "name" : "Account Invitation" }, { "name" : "Account Lifecycle Rule" }, { "name" : "Active Telephony Provider Configuration" }, { "name" : "Adaptive Access Policy (Adaptive MFA)" }, { "name" : "Admin Principal" }, { "name" : "API Security Policy" }, { "name" : "API Security Policy Scope" }, { "name" : "Application" }, { "name" : "Application Client" }, { "name" : "Application Variant" }, { "name" : "Audit entry" }, { "name" : "Available Role Scope" }, { "name" : "Branding Policy" }, { "name" : "Bridge Policy" }, { "name" : "Bridge Policy Resource" }, { "name" : "Bulk Operation" }, { "name" : "Claim" }, { "name" : "Consent" }, { "name" : "Dialect" }, { "name" : "Email Configuration" }, { "name" : "Enterprise Login Claim Mapping" }, { "name" : "Enterprise Login Provider" }, { "name" : "Event Streaming" }, { "name" : "Group" }, { "name" : "Group API Security Policy Assignment" }, { "name" : "Group Member" }, { "name" : "Identity Store" }, { "name" : "Identity Verification" }, { "name" : "Identity Verification Policy" }, { "name" : "Identity Verification Step" }, { "name" : "Instance Config" }, { "name" : "Lifecycle Event Hook" }, { "name" : "Lifecycle Event Hook Descriptor" }, { "name" : "Lifecycle Event Hook Log" }, { "name" : "Lifecycle Event Hook Tryout" }, { "name" : "Native Claim" }, { "name" : "Notification Policy" }, { "name" : "Notification Template" }, { "name" : "NPM Dependency" }, { "name" : "Organization" }, { "name" : "Organization Policy" }, { "name" : "Password Quality Policy" }, { "name" : "Personal Data" }, { "name" : "Plugin Library" }, { "name" : "Restricted Password" }, { "name" : "Role" }, { "name" : "Self Service Policy" }, { "name" : "Social Login Claim Mapping" }, { "name" : "Social Login Provider" }, { "name" : "Statistics" }, { "name" : "Telephony Provider Configuration" }, { "name" : "Translation" }, { "name" : "Variables" }, { "name" : "Web Analytics" } ], "paths" : { "/admin/api/v1/accessPolicies" : { "get" : { "description" : "You can list the existing API security policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_api_access |\n", "operationId" : "listApiAccessPolicies", "parameters" : [ { "description" : "Audience used for filtering", "in" : "query", "name" : "audience", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Assigned clients used for filtering", "in" : "query", "name" : "clients", "required" : false, "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "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" : "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/PageApiSecurityPolicyListResponse_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_api_access" ] } ], "summary" : "List API security policies", "tags" : [ "API Security Policy" ] }, "post" : { "description" : "You can create an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "createApiAccessPolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicy_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyResponse_ApiAccessPolicy" } } }, "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_api_access" ] } ], "summary" : "Create an API security policy", "tags" : [ "API Security Policy" ] } }, "/admin/api/v1/accessPolicies/{policyId}" : { "delete" : { "description" : "You can delete an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_api_access |\n", "operationId" : "deleteApiAccessPolicy", "parameters" : [ { "in" : "path", "name" : "policyId", "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" : "API security policy has assigned clients" } }, "security" : [ { "securityScheme" : [ "delete:config_api_access" ] } ], "summary" : "Delete an API security policy", "tags" : [ "API Security Policy" ] }, "get" : { "description" : "You can get an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_api_access |\n", "operationId" : "getApiAccessPolicy", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_api_access" ] } ], "summary" : "Get an API security policy", "tags" : [ "API Security Policy" ] }, "put" : { "description" : "You can update an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "updateApiAccessPolicy", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyUpsertRequest_ApiAccessPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyResponse_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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_api_access" ] } ], "summary" : "Update an API security policy", "tags" : [ "API Security Policy" ] } }, "/admin/api/v1/accessPolicies/{policyId}/assignments" : { "post" : { "description" : "You can assign a client to an API security policy by calling this endpoint. Only available clients can be assigned.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "createApplicationAssignment", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentUpsertRequest_ApiAccessPolicy" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentResponse_ApiAccessPolicy" } } }, "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:config_api_access" ] } ], "summary" : "Assign a client to an API security policy", "tags" : [ "API Security Policy" ] } }, "/admin/api/v1/accessPolicies/{policyId}/assignments/{clientId}" : { "delete" : { "description" : "You can delete an API security policy assignment by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "deleteApplicationAssignmentFromApiAccessPolicy", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_api_access" ] } ], "summary" : "Delete an API security policy assignment", "tags" : [ "API Security Policy" ] }, "get" : { "description" : "You can get an API security policy assignment for a given client ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_api_access |\n", "operationId" : "getApiAccessPolicyAssignmentByClientId", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApiSecurityPolicyAssignmentResponse_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_api_access" ] } ], "summary" : "Get an API security policy assignment", "tags" : [ "API Security Policy" ] }, "put" : { "description" : "You can update an API security policy assignment by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "updateApplicationAssignment", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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_api_access" ] } ], "summary" : "Update an API security policy assignment", "tags" : [ "API Security Policy" ] } }, "/admin/api/v1/accessPolicies/{policyId}/scopes" : { "post" : { "description" : "You can create a scope for an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "createScope", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Scope_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ScopeResponse_ApiAccessPolicy" } } }, "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:config_api_access" ] } ], "summary" : "Create a scope for an API security policy", "tags" : [ "API Security Policy Scope" ] } }, "/admin/api/v1/accessPolicies/{policyId}/scopes/{scopeId}" : { "delete" : { "description" : "You can delete a scope for an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "deleteScope", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "scopeId", "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" : "API security policy scope has assigned clients" } }, "security" : [ { "securityScheme" : [ "write:config_api_access" ] } ], "summary" : "Delete a scope for an API security policy", "tags" : [ "API Security Policy Scope" ] }, "get" : { "description" : "You can get a scope for an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_api_access |\n", "operationId" : "getScope", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "scopeId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ScopeResponse_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_api_access" ] } ], "summary" : "Get a scope for an API security policy", "tags" : [ "API Security Policy Scope" ] }, "put" : { "description" : "You can update a scope for an API security policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_api_access |\n", "operationId" : "updateScope", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "scopeId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ScopeUpsertRequest_ApiAccessPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ScopeResponse_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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_api_access" ] } ], "summary" : "Update a scope for an API security policy", "tags" : [ "API Security Policy Scope" ] } }, "/admin/api/v1/accountEventTTLs" : { "get" : { "description" : "Returns the list of account event TTL options defined in days. An account event TTL determines how long account events will be stored in a given identity store.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getAvailableAccountEventTTLs", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "integer", "format" : "int32" } } } }, "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_identity_store" ] } ], "summary" : "Get available account event TTLs", "tags" : [ "Account Event TTL" ] } }, "/admin/api/v1/adaptiveMfas" : { "get" : { "description" : "You can list the existing adaptive access policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_adaptive_mfa |\n", "operationId" : "getMFAPolicies", "parameters" : [ { "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" : "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/PageAdaptiveAccessPolicyResponse_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_adaptive_mfa" ] } ], "summary" : "List adaptive access policies", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] }, "post" : { "description" : "You can create an adaptive access policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_adaptive_mfa |\n", "operationId" : "createAdaptiveMFA", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicy_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyResponse_AdaptiveMFA" } } }, "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_adaptive_mfa" ] } ], "summary" : "Create an adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] } }, "/admin/api/v1/adaptiveMfas/location" : { "get" : { "description" : "You can search for locations by a prefix with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_adaptive_mfa |\n", "operationId" : "getMFAPolicyLocation", "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_adaptive_mfa" ] } ], "summary" : "Filter for locations", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] } }, "/admin/api/v1/adaptiveMfas/{id}" : { "delete" : { "description" : "You can delete an adaptive access policy by calling this endpoint. MFA policies assigned to applications or organization assignments cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_adaptive_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" : "Adaptive access policy is assigned to an Application or Organization or Variant assignment" } }, "security" : [ { "securityScheme" : [ "delete:config_adaptive_mfa" ] } ], "summary" : "Delete an adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] }, "get" : { "description" : "You can get an adaptive access policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_adaptive_mfa |\n", "operationId" : "getAdaptiveMFA", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyResponse_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_adaptive_mfa" ] } ], "summary" : "Get an adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] }, "put" : { "description" : "You can update an adaptive access policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_adaptive_mfa |\n", "operationId" : "updateAdaptiveMFA", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyRequest_AdaptiveMFA" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyResponse_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_adaptive_mfa" ] } ], "summary" : "Update an adaptive access policy", "tags" : [ "Adaptive Access Policy (Adaptive MFA)" ] } }, "/admin/api/v1/brands" : { "get" : { "description" : "You can list the existing branding policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_brand |\n", "operationId" : "getBrands", "parameters" : [ { "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" : "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/PageBrand_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_brand" ] } ], "summary" : "List branding policies", "tags" : [ "Branding Policy" ] }, "post" : { "description" : "You can create a branding policy by calling this endpoint. Primary and background colors are valid colors in hexadecimal format. For the additional content, either the `html` or the `link` field should be provided.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_brand |\n", "operationId" : "createBrand", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Brand_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Brand_Brand" } } }, "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_brand" ] } ], "summary" : "Create a branding policy", "tags" : [ "Branding Policy" ] } }, "/admin/api/v1/brands/{id}" : { "delete" : { "description" : "You can delete a branding policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_brand |\n", "operationId" : "deleteBrandById", "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" : "Default branding policy and branding policies assigned to applications or organization assignments cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_brand" ] } ], "summary" : "Delete a branding policy", "tags" : [ "Branding Policy" ] }, "get" : { "description" : "You can get a branding policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_brand |\n", "operationId" : "getBrand", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Brand_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_brand" ] } ], "summary" : "Get a branding policy", "tags" : [ "Branding Policy" ] }, "put" : { "description" : "You can update a branding policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_brand |\n", "operationId" : "updateBrand", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BrandUpsertRequest_Brand" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Brand_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_brand" ] } ], "summary" : "Update a branding policy", "tags" : [ "Branding Policy" ] } }, "/admin/api/v1/bulk" : { "head" : { "description" : "| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_bulk_operation |\n", "operationId" : "isRunning", "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" }, "429" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "There is a bulk operation running already." } }, "security" : [ { "securityScheme" : [ "read:admin_bulk_operation" ] } ], "summary" : "Query if there is a running bulk operation", "tags" : [ "Bulk Operation" ] }, "post" : { "description" : "By calling this endpoint you can create a bulk operation job, the endpoint responds with the id of the created job.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:admin_bulk_operation |\n", "operationId" : "createJob", "requestBody" : { "content" : { "application/x-ndjson" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/EnableAccountOperationRequest" }, { "$ref" : "#/components/schemas/DisableAccountOperationRequest" }, { "$ref" : "#/components/schemas/UpdatePersonalDataOperationRequest" } ] } } }, "description" : "JSON objects separated by new lines. The structure of the objects is specified below. Example:\n````\n{\"operation\": \"enableAccount\", \"identityStore\": \"[STORE_NAME]\", \"accountId\": \"[ACCOUNT_ID]\"}\n{\"operation\": \"disableAccount\", \"identityStore\": \"[STORE_NAME]\", \"accountId\": \"[ACCOUNT_ID]\"}\n{\"operation\": \"updatePersonalData\", \"identityStore\": \"[STORE_NAME]\", \"accountId\": \"[ACCOUNT_ID]\", \"value\": {\"name\": {\"givenName\": \"example name\"}}}\n````" }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JobIdReferenceResponse" } } }, "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" }, "429" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "There is a bulk operation running already." } }, "security" : [ { "securityScheme" : [ "write:admin_bulk_operation" ] } ], "summary" : "Create a bulk operation job", "tags" : [ "Bulk Operation" ] } }, "/admin/api/v1/bulk/{jobId}" : { "get" : { "description" : "By calling this endpoint you can get the status of a job.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_bulk_operation |\n", "operationId" : "getJobStatus", "parameters" : [ { "in" : "path", "name" : "jobId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BulkStatus" } } }, "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_bulk_operation" ] } ], "summary" : "Get status of a job", "tags" : [ "Bulk Operation" ] } }, "/admin/api/v1/bulk/{jobId}/errors" : { "get" : { "description" : "By calling this endpoint you can get a list of errors for a given job.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_bulk_operation |\n", "operationId" : "errors", "parameters" : [ { "in" : "path", "name" : "jobId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BulkOperationErrorEntry" } } } }, "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_bulk_operation" ] } ], "summary" : "Get errors for a job", "tags" : [ "Bulk Operation" ] } }, "/admin/api/v1/claim/dialects" : { "get" : { "description" : "You can list the existing dialects by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_claim |\n", "operationId" : "getDialects", "parameters" : [ { "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" : "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/PageDialectResponse_Dialect" } } }, "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_claim" ] } ], "summary" : "List dialects", "tags" : [ "Dialect" ] }, "post" : { "description" : "You can create a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "createDialect", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Dialect_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DialectResponse_Dialect" } } }, "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_claim" ] } ], "summary" : "Create a dialect", "tags" : [ "Dialect" ] } }, "/admin/api/v1/claim/dialects/{dialectId}/claims" : { "get" : { "description" : "You can list the existing claims of a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_claim |\n", "operationId" : "getClaims", "parameters" : [ { "in" : "path", "name" : "dialectId", "required" : true, "schema" : { "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/PageClaimResponse_Claim" } } }, "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_claim" ] } ], "summary" : "List claims", "tags" : [ "Claim" ] }, "post" : { "description" : "You can create a claim for a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "createClaim", "parameters" : [ { "in" : "path", "name" : "dialectId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClaimInsertRequest_Claim" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ClaimResponse_Claim" } } }, "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:config_claim" ] } ], "summary" : "Create a claim", "tags" : [ "Claim" ] } }, "/admin/api/v1/claim/dialects/{dialectId}/claims/{id}" : { "delete" : { "description" : "You can delete a claim for a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_claim |\n", "operationId" : "deleteClaimById", "parameters" : [ { "in" : "path", "name" : "dialectId", "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" } }, "security" : [ { "securityScheme" : [ "delete:config_claim" ] } ], "summary" : "Delete a claim", "tags" : [ "Claim" ] }, "get" : { "description" : "You can get a claim of a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_claim |\n", "operationId" : "getClaim", "parameters" : [ { "in" : "path", "name" : "dialectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ClaimResponse_Claim" } } }, "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_claim" ] } ], "summary" : "Get a claim", "tags" : [ "Claim" ] }, "put" : { "description" : "You can update a claim for a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "updateClaim", "parameters" : [ { "in" : "path", "name" : "dialectId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ClaimUpdateRequest_Claim" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ClaimResponse_Claim" } } }, "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_claim" ] } ], "summary" : "Update a claim", "tags" : [ "Claim" ] } }, "/admin/api/v1/claim/dialects/{id}" : { "delete" : { "description" : "You can delete a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_claim |\n", "operationId" : "deleteDialectById", "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" : "Dialect is assigned to an application client" } }, "security" : [ { "securityScheme" : [ "delete:config_claim" ] } ], "summary" : "Delete a dialect", "tags" : [ "Dialect" ] }, "get" : { "description" : "You can get a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_claim |\n", "operationId" : "getDialect", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DialectResponse_Dialect" } } }, "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_claim" ] } ], "summary" : "Get a dialect", "tags" : [ "Dialect" ] }, "put" : { "description" : "You can update a dialect by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "updateDialect", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DialectUpdateRequest_Dialect" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/DialectResponse_Dialect" } } }, "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_claim" ] } ], "summary" : "Update a dialect", "tags" : [ "Dialect" ] } }, "/admin/api/v1/claim/native" : { "get" : { "description" : "You can list the existing native claims by calling this endpoint.", "operationId" : "getAllNativeClaims", "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" : { "$ref" : "#/components/schemas/PageNativeClaimResponse_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" : [ ] } ], "summary" : "List native claims", "tags" : [ "Native Claim" ] }, "post" : { "description" : "You can create a native claim by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "createNativeClaim", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NativeClaim_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NativeClaim_NativeClaim" } } }, "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_claim" ] } ], "summary" : "Create a native claim", "tags" : [ "Native Claim" ] } }, "/admin/api/v1/claim/native/{id}" : { "delete" : { "description" : "You can delete a native claim by calling this endpoint. Native claims assigned to account attributes cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_claim |\n", "operationId" : "deleteNativeClaim", "parameters" : [ { "in" : "path", "name" : "id", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "The native claim is assigned to an account attribute and couldn't be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_claim" ] } ], "summary" : "Delete a native claim", "tags" : [ "Native Claim" ] }, "get" : { "description" : "You can get a native claim by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_claim |\n", "operationId" : "getNativeClaim", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_claim" ] } ], "summary" : "Get a native claim", "tags" : [ "Native Claim" ] }, "put" : { "description" : "You can update a native claim by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_claim |\n", "operationId" : "updateNativeClaim", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NativeClaim_NativeClaim" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NativeClaim_NativeClaim" } } }, "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_claim" ] } ], "summary" : "Update a native claim", "tags" : [ "Native Claim" ] } }, "/admin/api/v1/consents" : { "get" : { "description" : "You can list the existing consents by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_consent |\n", "operationId" : "getAllConsents", "parameters" : [ { "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" : "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/PageConsent_Consent" } } }, "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_consent" ] } ], "summary" : "List consents", "tags" : [ "Consent" ] }, "post" : { "description" : "You can create a consent by calling this endpoint. The version of the new consent must be 1.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_consent |\n", "operationId" : "createConsent", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Consent_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Consent_Consent" } } }, "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_consent" ] } ], "summary" : "Create a consent", "tags" : [ "Consent" ] } }, "/admin/api/v1/consents/{id}" : { "get" : { "description" : "You can get a consent by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_consent |\n", "operationId" : "getConsentById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Consent_Consent" } } }, "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_consent" ] } ], "summary" : "Get a consent", "tags" : [ "Consent" ] }, "put" : { "description" : "You can update a consent by calling this endpoint. The consent version must be unchanged or incremented by one.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_consent |\n", "operationId" : "updateConsent", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ConsentUpsertRequest_Consent" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Consent_Consent" } } }, "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_consent" ] } ], "summary" : "Update a consent", "tags" : [ "Consent" ] } }, "/admin/api/v1/eventHooks/descriptor" : { "get" : { "description" : "You can list the possible descriptors for lifecycle event hooks by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getAllEventHooks", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventHookDescriptorResponse_EventHookDescriptor" } } } }, "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_event_hook" ] } ], "summary" : "List descriptors for event hooks", "tags" : [ "Lifecycle Event Hook Descriptor" ] } }, "/admin/api/v1/eventHooks/function" : { "get" : { "description" : "You can list the existing lifecycle event hooks by calling this endpoint. Keep in mind that the `policyTags` query param is ignored when the `hook` query param is sent.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getAllEventHookFunctions", "parameters" : [ { "description" : "Type used for filtering", "in" : "query", "name" : "hook", "required" : false, "schema" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] } }, { "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" : "Name used for filtering", "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Specifies whether to include event hook status in response", "in" : "query", "name" : "withStatus", "required" : false, "schema" : { "type" : "boolean", "default" : false } }, { "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/PageEventHookFunctionListItemResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "List lifecycle event hooks", "tags" : [ "Lifecycle Event Hook" ] }, "post" : { "description" : "You can create a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_event_hook |\n", "operationId" : "createEventHookFunction", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventHookFunction_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookFunctionResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "Create a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] } }, "/admin/api/v1/eventHooks/function/{functionId}/test" : { "post" : { "description" : "You can create a tryout function resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_event_hook |\n", "operationId" : "createFunctionResource", "parameters" : [ { "in" : "path", "name" : "functionId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TryOutEventHookRequest_EventHookFunction" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TryOutEventHookIdResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "Create a tryout function resource", "tags" : [ "Lifecycle Event Hook Tryout" ] } }, "/admin/api/v1/eventHooks/function/{functionId}/test/{id}" : { "delete" : { "description" : "You can delete a tryout function resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_event_hook |\n", "operationId" : "deleteFunctionResource", "parameters" : [ { "in" : "path", "name" : "functionId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "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" } }, "security" : [ { "securityScheme" : [ "delete:config_event_hook" ] } ], "summary" : "Delete a tryout function resource", "tags" : [ "Lifecycle Event Hook Tryout" ] } }, "/admin/api/v1/eventHooks/function/{functionId}/test/{id}/call" : { "post" : { "description" : "You can call a tryout function resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_event_hook |\n", "operationId" : "callFunctionResource", "parameters" : [ { "in" : "path", "name" : "functionId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "format" : "uuid" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CallTryOutEventHookRequest_EventHookFunction" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/FunctionCallResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "Call a tryout function resource", "tags" : [ "Lifecycle Event Hook Tryout" ] } }, "/admin/api/v1/eventHooks/function/{id}" : { "delete" : { "description" : "You can delete a lifecycle event hook by calling this endpoint. If lifecycle event hook is assigned then cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_event_hook |\n", "operationId" : "deleteEventHookFunction", "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" : "Lifecycle event hook is assigned and cannot be deleted." } }, "security" : [ { "securityScheme" : [ "delete:config_event_hook" ] } ], "summary" : "Delete a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] }, "get" : { "description" : "You can get a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getEventHookFunctionById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookFunctionWithStatusResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "Get a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] }, "put" : { "description" : "You can update a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_event_hook |\n", "operationId" : "updateEventHookFunction", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EventHookFunctionRequest_EventHookFunction" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookFunctionResponse_EventHookFunction" } } }, "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_event_hook" ] } ], "summary" : "Update a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] } }, "/admin/api/v1/eventHooks/function/{id}/deploy" : { "post" : { "description" : "You can deploy a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_event_hook |\n", "operationId" : "deployEventHookFunction", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "text/plain" : { "schema" : { "type" : "object" } } }, "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" : { "text/plain" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:config_event_hook" ] } ], "summary" : "Deploy a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] } }, "/admin/api/v1/eventHooks/function/{id}/status" : { "get" : { "description" : "You an get the status of a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getEventHookFunctionStatusById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookStatusResponse_EventHookFunction" } } }, "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_event_hook" ] } ], "summary" : "Get status of a lifecycle event hook", "tags" : [ "Lifecycle Event Hook" ] } }, "/admin/api/v1/eventHooks/logs" : { "get" : { "description" : "You can list the event hook logs by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:event_hook_log |\n", "operationId" : "getEventHookLogs", "parameters" : [ { "in" : "query", "name" : "hookName", "required" : false, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "hookTypes", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "hookIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "accountIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "accountEventIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "clientIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "identityStores", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "logLevels", "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/EventHookLogListResponse" } } } }, "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:event_hook_log" ] } ], "summary" : "List event hook logs", "tags" : [ "Lifecycle Event Hook Log" ] } }, "/admin/api/v1/eventHooks/logs/{id}" : { "get" : { "description" : "You can get an event hook log by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:event_hook_log |\n", "operationId" : "getEventHookLogById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookLogResponse" } } }, "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:event_hook_log" ] } ], "summary" : "Get an event hook log", "tags" : [ "Lifecycle Event Hook Log" ] } }, "/admin/api/v1/eventHooks/npm/package" : { "post" : { "description" : "You can list the versions for an NPM dependency by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n| read:config_journey |\n| read:config_custom_mfa |\n", "operationId" : "getPackage", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NpmPackageRequest_Npm" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NpmPackage_Npm" } } }, "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_event_hook", "read:config_journey", "read:config_custom_mfa" ] } ], "summary" : "List NPM dependency versions", "tags" : [ "NPM Dependency" ] } }, "/admin/api/v1/eventHooks/npm/search" : { "post" : { "description" : "You can filter for NPM dependency suggestions for a lifecycle event hook by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n| read:config_journey |\n| read:config_custom_mfa |\n", "operationId" : "getSuggestions", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NpmPackageSuggestionsRequest_Npm" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NpmPackageSuggestion_Npm" } } } }, "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_event_hook", "read:config_journey", "read:config_custom_mfa" ] } ], "summary" : "Filter for NPM dependency suggestions for a lifecycle event hook", "tags" : [ "NPM Dependency" ] } }, "/admin/api/v1/events/account" : { "get" : { "description" : "You can list the account events by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:event_account |\n", "operationId" : "getAccountEvents", "parameters" : [ { "description" : "The applications in which the events occurred (specified by ID)", "in" : "query", "name" : "actorApplicationIds", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The applications in which the events occurred (specified by name)", "in" : "query", "name" : "actorApplicationNames", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The identity stores in which the events occurred (specified by ID)", "in" : "query", "name" : "subjectIdentityStores", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Labels indicating the type of events. Filter events that contain all the listed labels.", "in" : "query", "name" : "labels", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The accounts that were involved in the events", "in" : "query", "name" : "subjectAccountIds", "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" : "The IP addresses from which the events have been initiated. This represents a list of subnet ranges (CIDR). See: [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632)", "example" : "1.1.1.1/32", "in" : "query", "name" : "actorIps", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "The sessions in which the events occurred (`sid` claim in ID token)", "in" : "query", "name" : "loginSessionIds", "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" }, "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:event_account" ] } ], "summary" : "List account events", "tags" : [ "Account Event" ] } }, "/admin/api/v1/events/account/{eventId}" : { "get" : { "description" : "You can get an account event by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read: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:event_account" ] } ], "summary" : "Get an account event", "tags" : [ "Account Event" ] } }, "/admin/api/v1/events/descriptor" : { "get" : { "description" : "You can list the possible descriptors for account events by calling this endpoint. Descriptors for account events are in the following format: `(failure|success):{eventType}`.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read: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:event_account" ] } ], "summary" : "List descriptors for account events", "tags" : [ "Account Event" ] } }, "/admin/api/v1/events/notification" : { "get" : { "description" : "You can list the notification events by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:event_account |\n", "operationId" : "getNotificationEvents", "parameters" : [ { "description" : "The identity stores in which the notification events occurred (specified by ID)", "in" : "query", "name" : "identityStores", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "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" }, "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:event_account" ] } ], "summary" : "List notification events", "tags" : [ "Account Event" ] } }, "/admin/api/v1/events/notification/{eventId}" : { "get" : { "description" : "You can get a notification event by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read: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:event_account" ] } ], "summary" : "Get a notification event", "tags" : [ "Account Event" ] } }, "/admin/api/v1/identityProofings" : { "get" : { "description" : "You can list the existing identity verification policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_proofing |\n", "operationId" : "getAllIdentityProofings", "parameters" : [ { "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" : "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/PageIdentityProofingListResponse_IdentityProofing" } } }, "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_identity_proofing" ] } ], "summary" : "List identity verification policies", "tags" : [ "Identity Verification Policy" ] }, "post" : { "description" : "You can create an identity verification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "createIdentityProofing", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IdentityProofing_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityProofingResponse_IdentityProofing" } } }, "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_identity_proofing" ] } ], "summary" : "Create an identity verification policy", "tags" : [ "Identity Verification Policy" ] } }, "/admin/api/v1/identityProofings/{identityProofingId}/steps" : { "get" : { "description" : "You can list the existing identity verification steps by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_proofing |\n", "operationId" : "findAll", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "$ref" : "#/components/schemas/AddressRiskEvaluationStepResponse" }, { "$ref" : "#/components/schemas/DocumentVerificationStepResponse" }, { "$ref" : "#/components/schemas/KnowledgeBasedVerificationStepResponse" }, { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationStepResponse" }, { "$ref" : "#/components/schemas/PhoneNumberRiskStepResponse" }, { "$ref" : "#/components/schemas/ProofingDataStepResponse" } ] } } } }, "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_identity_proofing" ] } ], "summary" : "List identity verification steps", "tags" : [ "Identity Verification Step" ] }, "post" : { "description" : "You can create an identity verification step by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "create_7", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_AddressRiskEvaluationStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_DataStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_DocumentBasedStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_KnowledgeBasedStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_PhoneBasedStep_InsertRequest" }, { "$ref" : "#/components/schemas/IdentityVerification_PhoneNumberRiskStep_InsertRequest" } ] } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "$ref" : "#/components/schemas/AddressRiskEvaluationStepResponse" }, { "$ref" : "#/components/schemas/DocumentVerificationStepResponse" }, { "$ref" : "#/components/schemas/KnowledgeBasedVerificationStepResponse" }, { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationStepResponse" }, { "$ref" : "#/components/schemas/PhoneNumberRiskStepResponse" }, { "$ref" : "#/components/schemas/ProofingDataStepResponse" } ] } } }, "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:config_identity_proofing" ] } ], "summary" : "Create an identity verification step", "tags" : [ "Identity Verification Step" ] }, "put" : { "description" : "You can reorder verification steps by calling this endpoint. Request body should contain the existing verification step IDs in the desired order.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "reorder", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_IdentityProofing" } } } }, "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:config_identity_proofing" ] } ], "summary" : "Reorder verification steps", "tags" : [ "Identity Verification Step" ] } }, "/admin/api/v1/identityProofings/{identityProofingId}/steps/{id}" : { "delete" : { "description" : "You can delete an identity verification step by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "deleteById", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "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_identity_proofing" ] } ], "summary" : "Delete an identity verification step", "tags" : [ "Identity Verification Step" ] }, "get" : { "description" : "You can get an identity verification step by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_proofing |\n", "operationId" : "findById", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "$ref" : "#/components/schemas/AddressRiskEvaluationStepResponse" }, { "$ref" : "#/components/schemas/DocumentVerificationStepResponse" }, { "$ref" : "#/components/schemas/KnowledgeBasedVerificationStepResponse" }, { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationStepResponse" }, { "$ref" : "#/components/schemas/PhoneNumberRiskStepResponse" }, { "$ref" : "#/components/schemas/ProofingDataStepResponse" } ] } } }, "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_identity_proofing" ] } ], "summary" : "Get an identity verification step", "tags" : [ "Identity Verification Step" ] }, "put" : { "description" : "You can update an identity verification step by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "update_7", "parameters" : [ { "in" : "path", "name" : "identityProofingId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskEvaluationStep" }, { "$ref" : "#/components/schemas/IdentityVerificationDataStep" }, { "$ref" : "#/components/schemas/IdentityVerificationDocumentBasedStep" }, { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedStep" }, { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStep" }, { "$ref" : "#/components/schemas/IdentityVerificationPhoneNumberRiskStep" } ] } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "$ref" : "#/components/schemas/AddressRiskEvaluationStepResponse" }, { "$ref" : "#/components/schemas/DocumentVerificationStepResponse" }, { "$ref" : "#/components/schemas/KnowledgeBasedVerificationStepResponse" }, { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationStepResponse" }, { "$ref" : "#/components/schemas/PhoneNumberRiskStepResponse" }, { "$ref" : "#/components/schemas/ProofingDataStepResponse" } ] } } }, "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_identity_proofing" ] } ], "summary" : "Update an identity verification step", "tags" : [ "Identity Verification Step" ] } }, "/admin/api/v1/identityProofings/{id}" : { "delete" : { "description" : "You can delete an identity verification policy by calling this endpoint. Identity verification policies assigned to applications cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_identity_proofing |\n", "operationId" : "deleteIdentityProofingById", "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" : "The Identity Proofing is assigned to applications or organization assignments and cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_identity_proofing" ] } ], "summary" : "Delete an identity verification policy", "tags" : [ "Identity Verification Policy" ] }, "get" : { "description" : "You can get an identity verification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_proofing |\n", "operationId" : "getIdentityProofingById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityProofingResponse_IdentityProofing" } } }, "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_identity_proofing" ] } ], "summary" : "Get an identity verification policy", "tags" : [ "Identity Verification Policy" ] }, "put" : { "description" : "You can update an identity verification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_proofing |\n", "operationId" : "updateIdentityProofing", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IdentityProofingUpsertRequest_IdentityProofing" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityProofingResponse_IdentityProofing" } } }, "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_identity_proofing" ] } ], "summary" : "Update an identity verification policy", "tags" : [ "Identity Verification Policy" ] } }, "/admin/api/v1/identityStores" : { "get" : { "description" : "You can list the existing identity stores by calling this endpoint. Keep in mind that the `policyTags` query param is ignored when using this endpoint without the `read:config_identity_store` scope.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getIdentityStores", "parameters" : [ { "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" : "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/PageIdentityStoreListResponse" } } }, "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_identity_store" ] } ], "summary" : "List identity stores", "tags" : [ "Identity Store" ] }, "post" : { "description" : "You can create an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createIdentityStore", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IdentityStoreUpsertRequest_IdentityStore" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityStoreResponse_IdentityStore" } } }, "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_identity_store" ] } ], "summary" : "Create an identity store", "tags" : [ "Identity Store" ] } }, "/admin/api/v1/identityStores/{identityStoreName}" : { "delete" : { "description" : "You can delete an identity store by calling this endpoint. When you try to delete an identity store that's still in use (assigned to an application, contains identities or pending invitations), this endpoint will return a 409 Conflict response.\n\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_identity_store |\n", "operationId" : "deleteIdentityStoreByName", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "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" : "Identity Store has assigned entities" } }, "security" : [ { "securityScheme" : [ "delete:config_identity_store" ] } ], "summary" : "Delete an identity store", "tags" : [ "Identity Store" ] }, "get" : { "description" : "You can get an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getIdentityStore", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityStoreResponse" } } }, "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_identity_store" ] } ], "summary" : "Get an identity store", "tags" : [ "Identity Store" ] }, "put" : { "description" : "You can update an identity store by calling this endpoint. The request path and body should contain the same name for a successful update. The name of an identity store cannot be altered.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateIdentityStore", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/IdentityStoreUpsertRequest_IdentityStore" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/IdentityStoreResponse_IdentityStore" } } }, "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_identity_store" ] } ], "summary" : "Update an identity store", "tags" : [ "Identity Store" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts" : { "get" : { "description" : "You can list the existing accounts by calling this endpoint. Filtering can be done by the parameters listed below and by custom searchable attributes. The `password` type authenticator will be excluded from the response.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "listAccounts", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Custom filter applicable only for searchable attribute in the following format: `attribute_[path]`, e.g. `attribute_name.givenName`", "in" : "query", "name" : "attribute_[path]", "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" : "Organization ID", "in" : "query", "name" : "organization", "schema" : { "type" : "string" } }, { "description" : "Filter accounts that are under the provided unique identifier organization ID", "in" : "query", "name" : "organizationScope", "schema" : { "type" : "string" } }, { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "Group IDs used for filtering", "in" : "query", "name" : "groups" }, { "description" : "Type of inclusion used for groups filter. By setting to `exclude` makes it an `AND` relationship within the values of the groups parameter.", "in" : "query", "name" : "groupsFilter", "schema" : { "type" : "string", "enum" : [ "include", "exclude" ] } }, { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "Organization-role pairs used for filtering, should be provided in the following form: `[organizationId]:[roleId]`", "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" }, "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:account" ] } ], "summary" : "List accounts", "tags" : [ "Account" ] }, "post" : { "description" : "You can create an account by calling this endpoint.\n\nIdentifiers must be set depending on which identifiers are mandatory in the identity store.\nUsername: `local.id`\nEmail: `email.id`\nPhone: `phone.id`\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "createAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountInsertRequest_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:account" ] } ], "summary" : "Create an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}" : { "delete" : { "description" : "You can delete an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:account |\n", "operationId" : "deleteAccountById", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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" : [ "delete:account" ] } ], "summary" : "Delete an account", "tags" : [ "Account" ] }, "get" : { "description" : "You can get an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "getAccountById", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Get an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings" : { "get" : { "description" : "You can list the existing identity verifications by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account_proofing |\n", "operationId" : "getAccountProofing", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CustomerIdentityVerificationResponse_AccountProofing" } } } }, "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:account_proofing" ] } ], "summary" : "List identity verifications", "tags" : [ "Identity Verification" ] }, "post" : { "description" : "You can create an identity verification for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_proofing |\n", "operationId" : "addAccountProofing", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/CustomerIdentityVerificationInsertRequest_AccountProofing" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomerIdentityVerificationResponse_AccountProofing" } } }, "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:account_proofing" ] } ], "summary" : "Create an identity verification", "tags" : [ "Identity Verification" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}" : { "delete" : { "description" : "You can delete the attempts for an identity verification by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:account_proofing |\n", "operationId" : "deleteAccountProofingFailures", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountProofingId", "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" : [ "delete:account_proofing" ] } ], "summary" : "Delete attempts for an identity verification", "tags" : [ "Identity Verification" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/accountProofings/{accountProofingId}/invalidate" : { "post" : { "description" : "You can invalidate an identity verification by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_proofing |\n", "operationId" : "invalidateAccountProofing", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountProofingId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/CustomerIdentityVerificationResponse_AccountProofing" } } }, "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:account_proofing" ] } ], "summary" : "Invalidate an identity verification", "tags" : [ "Identity Verification" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/authenticators" : { "post" : { "description" : "You can create an authenticator for an account by calling this endpoint. Authenticator type can be either `email` or `phone`.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_authenticator |\n", "operationId" : "addAuthenticator", "parameters" : [ { "description" : "Header containing the client object identifier (not the OIDC client ID)", "in" : "header", "name" : "X-Notification-By-Application", "required" : false, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_authenticator" ] } ], "summary" : "Create authenticator for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/authenticators/{authenticatorId}" : { "delete" : { "description" : "You can delete an authenticator for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:account_authenticator |\n", "operationId" : "deleteAuthenticator", "parameters" : [ { "description" : "Header containing the client object identifier (not the OIDC client ID)", "in" : "header", "name" : "X-Notification-By-Application", "required" : false, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_authenticator" ] } ], "summary" : "Delete authenticator for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/disable" : { "post" : { "description" : "You can disable an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "disableAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Disable an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/download" : { "get" : { "description" : "You can download the account information in HTML or JSON format by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account_download |\n", "operationId" : "getPersonalData", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_download" ] } ], "summary" : "Download account information", "tags" : [ "Personal Data" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/enable" : { "post" : { "description" : "You can enable an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "enableAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Enable an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/groups" : { "post" : { "description" : "You can assign one or multiple groups to an account by calling this endpoint. To use this endpoint, both `read:config_identity_store` and `write:account` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n| write:account |\n", "operationId" : "addGroupsToAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "maxItems" : 2147483647, "minItems" : 1, "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" : [ "read:config_identity_store", "write:account" ] } ], "summary" : "Assign groups to an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/identities" : { "get" : { "description" : "You can list the identities for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account_identity |\n", "operationId" : "getIdentities", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_identity" ] } ], "summary" : "List identities for an account", "tags" : [ "Account Identity" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/identities/identifier" : { "post" : { "description" : "You can update the identifier for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_identity |\n", "operationId" : "updateAccountIdentifier", "parameters" : [ { "description" : "Header containing the client object identifier (not the OIDC client ID)", "in" : "header", "name" : "X-Notification-By-Application", "required" : false, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_identity" ] } ], "summary" : "Update identifier for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/impersonation" : { "post" : { "description" : "You can request an impersonation for an account by calling this endpoint. A impersonation link will be generated to impersonate the corresponding account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_impersonation |\n", "operationId" : "impersonation", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ImpersonationInsertRequest_Account" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ImpersonationResponse_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" } }, "security" : [ { "securityScheme" : [ "write:account_impersonation" ] } ], "summary" : "Request impersonation of an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/liftPasscodeLock" : { "post" : { "description" : "You can lift passcode lock for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "liftPasscodeLock", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Lift passcode lock for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/liftPasswordLock" : { "post" : { "description" : "You can lift password lock for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "liftPasswordLock", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Lift password lock for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/organization" : { "put" : { "description" : "You can change the organization of an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "updateAccountOrganization", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountOrganizationUpdateRequest" } } }, "required" : true }, "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:account" ] } ], "summary" : "Update organization for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/password/change" : { "post" : { "description" : "You can change the password for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_authenticator |\n", "operationId" : "resetPassword", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account_authenticator" ] } ], "summary" : "Change password for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/password/reset" : { "post" : { "description" : "You can request a password reset for an account by calling this endpoint. A password reset email will be sent to the email address of the corresponding account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account_authenticator |\n", "operationId" : "adminInitiatedPasswordReset", "parameters" : [ { "description" : "Header containing the client object identifier (not the OIDC client ID)", "in" : "header", "name" : "X-Notification-By-Application", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "identityStoreName", "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" } }, "security" : [ { "securityScheme" : [ "write:account_authenticator" ] } ], "summary" : "Request password reset for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/personal" : { "put" : { "description" : "You can update the metadata of an account by calling this endpoint. Attributes specified in the identity store can be modified for an account. 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:account |\n", "operationId" : "updateLocalMetadata", "parameters" : [ { "description" : "Header containing the client object identifier (not the OIDC client ID)", "in" : "header", "name" : "X-Notification-By-Application", "required" : false, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:account" ] } ], "summary" : "Update metadata of an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/roles" : { "get" : { "description" : "You can list existing organization role assignments for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "getAccountRolesById", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountRole_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:account" ] } ], "summary" : "List role assignments for an account", "tags" : [ "Account" ] }, "post" : { "description" : "You can assign one or more organization roles for an account by calling this endpoint. To use this endpoint, both `read:config_identity_store` and `write:account` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n| write:account |\n", "operationId" : "addRolesToAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleAssignmentRequest_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" : [ "read:config_identity_store", "write:account" ] } ], "summary" : "Assign multiple roles to an organization for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/roles/{roleId}" : { "delete" : { "description" : "You can delete an organization role assignment from an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "deleteRolesFromAccount", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "accountId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "roleId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "organization", "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:account" ] } ], "summary" : "Delete an organization role assignment from an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/sessions" : { "delete" : { "description" : "You can clear the sessions for an account by calling this endpoint. Note that clearing sessions for an account results in logging out of all browsers that user had been logged into previously. This performs a back-channel logout on the specified account.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "clearAccountDeviceSessions", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Clear sessions for an account", "tags" : [ "Account" ] }, "get" : { "description" : "You can list the sessions for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "getIdentifiedAccountDeviceSessions", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:account" ] } ], "summary" : "List sessions for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/accounts/{accountId}/sessions/{sessionId}" : { "delete" : { "description" : "You can delete a session for an account by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "deleteAccountDeviceSession", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Delete session for an account", "tags" : [ "Account" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/attributes" : { "get" : { "description" : "You can list the existing attributes for an identity store with this API.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getAllAccountAttributes", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_identity_store" ] } ], "summary" : "List attributes", "tags" : [ "Account Attribute" ] }, "post" : { "description" : "You can create an attribute for an identity store by calling this endpoint. A maximum of 5 indexed attributes can be created for an identity store.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createAccountAttribute", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/Checkbox_AccountAttribute_InsertRequest" }, { "$ref" : "#/components/schemas/Date_AccountAttribute_InsertRequest" }, { "$ref" : "#/components/schemas/PhoneNumber_AccountAttribute_InsertRequest" }, { "$ref" : "#/components/schemas/Select_AccountAttribute_InsertRequest" }, { "$ref" : "#/components/schemas/String_AccountAttribute_InsertRequest" } ] } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "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" : "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_identity_store" ] } ], "summary" : "Create an attribute", "tags" : [ "Account Attribute" ] }, "put" : { "description" : "You can reorder attributes for an identity store by calling this endpoint. Request body should contain the existing attribute IDs in the desired order.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "reorderAccountAttributes", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_AccountAttribute" } } } }, "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:config_identity_store" ] } ], "summary" : "Reorder attributes", "tags" : [ "Account Attribute" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/attributes/{id}" : { "get" : { "description" : "You can get an attribute for an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getAccountAttribute", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "read:config_identity_store" ] } ], "summary" : "Get an Attribute", "tags" : [ "Account Attribute" ] }, "put" : { "description" : "You can update an attribute for an identity store by calling this endpoint. The attribute type, name, path and searchability cannot be altered.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateAccountAttribute", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "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" } ] } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "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" }, "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_identity_store" ] } ], "summary" : "Update an attribute", "tags" : [ "Account Attribute" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/availableNativeClaims" : { "get" : { "description" : "You can list the available native claims of an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getAvailableNativeClaims", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NativeClaimResponse" } } } }, "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_identity_store" ] } ], "summary" : "List available native claims", "tags" : [ "Identity Store" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups" : { "get" : { "description" : "You can list the existing groups by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getGroups", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Account IDs to be included", "in" : "query", "name" : "ids", "required" : false, "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Account IDs to be excluded", "in" : "query", "name" : "nids", "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/PageGroupResponse" } } }, "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_identity_store" ] } ], "summary" : "List groups", "tags" : [ "Group" ] }, "post" : { "description" : "You can create a group by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupInsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupResponse" } } }, "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:config_identity_store" ] } ], "summary" : "Create a group", "tags" : [ "Group" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments" : { "get" : { "description" : "You can list existing API security policy assignments for a given group ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "listGroupApiAccessPolicyAssignments", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentResponse" } } } }, "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_identity_store" ] } ], "summary" : "List API security policy assignments for a group", "tags" : [ "Group API Security Policy Assignment" ] }, "post" : { "description" : "You can assign an API security policy and its scopes to a group by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createGroupApiAccessPolicyAssignment", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentResponse" } } }, "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:config_identity_store" ] } ], "summary" : "Assign API security policy to a group", "tags" : [ "Group API Security Policy Assignment" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/apiAccessPolicyAssignments/{apiAccessPolicyId}" : { "delete" : { "description" : "You can delete a group API security policy assignment by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "deleteGroupApiAccessPolicyAssignment", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "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_identity_store" ] } ], "summary" : "Delete a group API security policy assignment", "tags" : [ "Group API Security Policy Assignment" ] }, "get" : { "description" : "You can get an API security policy assignment for a given group ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getGroupApiAccessPolicyAssignment", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentResponse" } } }, "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_identity_store" ] } ], "summary" : "Get API security policy assignment for a group", "tags" : [ "Group API Security Policy Assignment" ] }, "put" : { "description" : "You can update the scopes of an API security policy group assignment by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateGroupApiAccessPolicyAssignment", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupApiSecurityPolicyAssignmentResponse" } } }, "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_identity_store" ] } ], "summary" : "Update assigned scopes", "tags" : [ "Group API Security Policy Assignment" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members" : { "get" : { "description" : "You can list the existing group members by calling this endpoint. To use this endpoint, both `read:config_identity_store` and `read:account` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n| read:account |\n", "operationId" : "listGroupMembers", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Custom filter applicable only for searchable attribute in the following format: `attribute_[path]`, e.g. `attribute_name.givenName`", "in" : "query", "name" : "attribute_[path]", "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" : "Organization ID", "in" : "query", "name" : "organization", "schema" : { "type" : "string" } }, { "description" : "Filter accounts that are under the provided unique identifier organization ID", "in" : "query", "name" : "organizationScope", "schema" : { "type" : "string" } }, { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } }, "description" : "Organization-role pairs used for filtering, should be provided in the following form: `[organizationId]:[roleId]`", "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" }, "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_identity_store", "read:account" ] } ], "summary" : "List group members", "tags" : [ "Group Member" ] }, "post" : { "description" : "You can add a member to a group by calling this endpoint. To use this endpoint, both `read:config_identity_store` and `write:account` scopes should be granted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n| write:account |\n", "operationId" : "addGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupMemberInsertRequest_Account" } } }, "required" : true }, "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" : [ "read:config_identity_store", "write:account" ] } ], "summary" : "Add member to a group", "tags" : [ "Group Member" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups/{groupId}/members/{accountId}" : { "delete" : { "description" : "You can remove a member from a group by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "removeGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "groupId", "required" : true, "schema" : { "type" : "string" } }, { "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:account" ] } ], "summary" : "Remove member from a group", "tags" : [ "Group Member" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/groups/{id}" : { "delete" : { "description" : "You can delete a group by calling this endpoint. Groups that have members cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "deleteGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "This group still has members and cannot be deleted" } }, "security" : [ { "securityScheme" : [ "write:config_identity_store" ] } ], "summary" : "Delete a group", "tags" : [ "Group" ] }, "get" : { "description" : "You can get a group by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupResponse" } } }, "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_identity_store" ] } ], "summary" : "Get a group", "tags" : [ "Group" ] }, "put" : { "description" : "You can update a group by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateGroup", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GroupUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GroupResponse" } } }, "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_identity_store" ] } ], "summary" : "Update a group", "tags" : [ "Group" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/invite" : { "get" : { "description" : "You can list the existing account invitations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "getAccountInvitations", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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/AccountInvitationResponse_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:account" ] } ], "summary" : "List account invitations", "tags" : [ "Account Invitation" ] }, "post" : { "description" : "You can create an account invitation by calling this endpoint. An invite will be sent to the given email address to register a new account. If the given client doesn't have a login url, a bad request will be returned. If a pending invitation exists with the given email address, the response contains the existing invitation ID. If an account exists with the given email address and email mismatch is allowed in the Self-service policy, the invitation will be sent.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "createInvitation", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AccountInvitationInsertRequest_AccountInvitationDetails" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountInvitationResponse_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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/InvitationConflictProblemJson_AccountInvitationDetails" } } }, "description" : "Account with this email identifier already exists and email mismatch is not allowed 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:account" ] } ], "summary" : "Create an account invitation", "tags" : [ "Account Invitation" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}" : { "delete" : { "description" : "You can revoke an account invitation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "deleteAccountInvitation", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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" }, "404" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" } }, "security" : [ { "securityScheme" : [ "write:account" ] } ], "summary" : "Revoke an account invitation", "tags" : [ "Account Invitation" ] }, "get" : { "description" : "You can get an account invitation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:account |\n", "operationId" : "getAccountInvitation", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "invitationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountInvitationResponse_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:account" ] } ], "summary" : "Get an account invitation", "tags" : [ "Account Invitation" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/invite/{invitationId}/resend" : { "post" : { "description" : "You can resend an account invitation by calling this endpoint. Once an invite is sent, the `validUntil` field is updated.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:account |\n", "operationId" : "resendInvitation", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "invitationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AccountInvitationResponse_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:account" ] } ], "summary" : "Resend an account invitation", "tags" : [ "Account Invitation" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules" : { "get" : { "description" : "You can list the existing lifecycle rules of an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "listLifecycleRules", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LifecycleRuleListResponse" } } } }, "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_identity_store" ] } ], "summary" : "List account lifecycle rules", "tags" : [ "Account Lifecycle Rule" ] }, "post" : { "description" : "You can create a lifecycle rule by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createLifecycleRule", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LifecycleRuleInsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/LifecycleRuleResponse" } } }, "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:config_identity_store" ] } ], "summary" : "Create an account lifecycle rule", "tags" : [ "Account Lifecycle Rule" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/lifecycleRules/{lifecycleRuleId}" : { "delete" : { "description" : "You can delete a lifecycle rule by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "deleteLifecycleRule", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "lifecycleRuleId", "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_identity_store" ] } ], "summary" : "Delete an account lifecycle rule", "tags" : [ "Account Lifecycle Rule" ] }, "get" : { "description" : "You can get a lifecycle rule by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getLifecycleRule", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "lifecycleRuleId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/LifecycleRuleResponse" } } }, "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_identity_store" ] } ], "summary" : "Get an account lifecycle rule", "tags" : [ "Account Lifecycle Rule" ] }, "put" : { "description" : "You can update a lifecycle rule by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateLifecycleRule", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "lifecycleRuleId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/LifecycleRuleUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/LifecycleRuleResponse" } } }, "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_identity_store" ] } ], "summary" : "Update an account lifecycle rule", "tags" : [ "Account Lifecycle Rule" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/nativeClaimMappings" : { "get" : { "description" : "You can list the current native claim mappings of an identity store by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getNativeClaimMappings", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "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_identity_store" ] } ], "summary" : "List native claim mappings", "tags" : [ "Identity Store" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/organizations" : { "get" : { "description" : "You can list the existing organizations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getOrganizations", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "description" : "Filter organizations which are under the provided unique identifier organization id", "in" : "query", "name" : "uniqueIdentifierRoot", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Filter organizations where the unique identifier value is matching", "in" : "query", "name" : "uniqueIdentifier", "required" : false, "schema" : { "type" : "boolean" } }, { "description" : "Filter organizations where one of the routes value is equal with the provided value", "in" : "query", "name" : "route", "required" : false, "schema" : { "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" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrganizationResponse" } } } }, "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_identity_store" ] } ], "summary" : "List organizations", "tags" : [ "Organization" ] }, "post" : { "description" : "You can create an organization by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "createOrganization", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Organization_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationResponse" } } }, "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:config_identity_store" ] } ], "summary" : "Create an organization", "tags" : [ "Organization" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/organizations/{id}" : { "delete" : { "description" : "You can delete an organization by calling this endpoint. Organizations assigned to applications, organizations with accounts or roles in it, and parent organizations cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "deleteOrganization", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict can happen in various cases:\n- is a parent organization\n- has assigned accounts\n- has assigned roles\n- has assigned clients\n- has assigned applications" } }, "security" : [ { "securityScheme" : [ "write:config_identity_store" ] } ], "summary" : "Delete an organization", "tags" : [ "Organization" ] }, "get" : { "description" : "You can get an organization by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getOrganization", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationResponse" } } }, "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_identity_store" ] } ], "summary" : "Get an organization", "tags" : [ "Organization" ] }, "put" : { "description" : "You can update an organization by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "updateOrganization", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationUpsertRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationResponse" } } }, "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_identity_store" ] } ], "summary" : "Update an organization", "tags" : [ "Organization" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/roles" : { "get" : { "description" : "You can list the existing roles by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "list_7", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "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/PageRoleResponse_Role" } } }, "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_identity_store" ] } ], "summary" : "List roles", "tags" : [ "Role" ] }, "post" : { "description" : "You can create a role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "create_6", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Role_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RoleResponse_Role" } } }, "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:config_identity_store" ] } ], "summary" : "Create a role", "tags" : [ "Role" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/roles/{id}" : { "delete" : { "description" : "You can delete a role by calling this endpoint. Roles assigned to accounts cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "delete_8", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "A role that's assigned to an account cannot be deleted" } }, "security" : [ { "securityScheme" : [ "write:config_identity_store" ] } ], "summary" : "Delete a role", "tags" : [ "Role" ] }, "get" : { "description" : "You can get a role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "get_6", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RoleResponse_Role" } } }, "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_identity_store" ] } ], "summary" : "Get a role", "tags" : [ "Role" ] }, "put" : { "description" : "You can update a role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_identity_store |\n", "operationId" : "update_6", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/RoleUpsertRequest_Role" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/RoleResponse_Role" } } }, "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_identity_store" ] } ], "summary" : "Update a role", "tags" : [ "Role" ] } }, "/admin/api/v1/identityStores/{identityStoreName}/scopes" : { "get" : { "description" : "You can list the available scopes for a role by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_identity_store |\n", "operationId" : "getScopes", "parameters" : [ { "in" : "path", "name" : "identityStoreName", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AvailableScopeResponse" } } } }, "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_identity_store" ] } ], "summary" : "List available scopes", "tags" : [ "Available Role Scope" ] } }, "/admin/api/v1/instance/config" : { "get" : { "description" : "You can get the instance configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance |\n", "operationId" : "getInstanceConfig", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/InstanceConfigResponse_InstanceConfig" } } }, "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_instance" ] } ], "summary" : "Get instance config", "tags" : [ "Instance Config" ] }, "post" : { "description" : "You can update the instance configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "updateInstanceConfig", "parameters" : [ ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/InstanceConfig_InsertRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/InstanceConfigResponse_InstanceConfig" } } }, "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_instance" ] } ], "summary" : "Update instance config", "tags" : [ "Instance Config" ] } }, "/admin/api/v1/instance/config/addresses" : { "get" : { "description" : "You can get the instance address by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance |\n| read:config_application |\n", "operationId" : "getInstanceAddress", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/InstanceAddress_InstanceConfig" } } }, "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_instance", "read:config_application" ] } ], "summary" : "Get instance address", "tags" : [ "Instance Config" ] } }, "/admin/api/v1/instance/email" : { "get" : { "description" : "You can get the email configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance |\n", "operationId" : "getEmailConfig", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EmailConfigResponse_InstanceConfig" } } }, "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_instance" ] } ], "summary" : "Get email configuration", "tags" : [ "Email Configuration" ] }, "post" : { "description" : "You can update the email configuration by calling this endpoint. If set to enabled, a username, a server and a connection type should be present in the request.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "updateEmailConfig", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/EmailConfigUpdateRequest_InstanceConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EmailConfigResponse_InstanceConfig" } } }, "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_instance" ] } ], "summary" : "Update email configuration", "tags" : [ "Email Configuration" ] } }, "/admin/api/v1/instance/eventStreaming" : { "get" : { "description" : "You can list the existing event streaming configurations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance |\n", "operationId" : "list_6", "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" : { "$ref" : "#/components/schemas/PageEventStreamingResponse" } } }, "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_instance" ] } ], "summary" : "List event streaming configurations", "tags" : [ "Event Streaming" ] }, "post" : { "description" : "You can create an event streaming configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "create_5", "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/ElasticsearchEventStreamingInsertRequest" }, { "$ref" : "#/components/schemas/HttpsEventStreamingInsertRequest" }, { "$ref" : "#/components/schemas/SplunkEventStreamingInsertRequest" } ] } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventStreamingResponse" } } }, "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_instance" ] } ], "summary" : "Create an event streaming configuration", "tags" : [ "Event Streaming" ] } }, "/admin/api/v1/instance/eventStreaming/{id}" : { "delete" : { "description" : "You can delete an event streaming configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "delete_7", "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" : [ "write:config_instance" ] } ], "summary" : "Delete an event streaming configuration", "tags" : [ "Event Streaming" ] }, "get" : { "description" : "You can get an event streaming configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance |\n", "operationId" : "getById", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventStreamingResponse" } } }, "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_instance" ] } ], "summary" : "Get an event streaming configuration", "tags" : [ "Event Streaming" ] }, "put" : { "description" : "You can update an event streaming configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "update_5", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/ElasticsearchEventStreamingUpdateRequest" }, { "$ref" : "#/components/schemas/HttpsEventStreamingUpdateRequest" }, { "$ref" : "#/components/schemas/SplunkEventStreamingUpdateRequest" } ] } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventStreamingResponse" } } }, "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_instance" ] } ], "summary" : "Update an event streaming configuration", "tags" : [ "Event Streaming" ] } }, "/admin/api/v1/instance/eventStreaming/{id}/test" : { "post" : { "description" : "You can test an event streaming configuration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance |\n", "operationId" : "sendTestEvent", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventStreamingTestResponse" } } }, "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:config_instance" ] } ], "summary" : "Test an event streaming configuration", "tags" : [ "Event Streaming" ] } }, "/admin/api/v1/instance/telephony/activeProviders" : { "get" : { "description" : "You can list active telephony service providers by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_telephony_service_provider |\n", "operationId" : "readActiveTelephonyProviders", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ActiveTelephonyProviderResponse" } } } }, "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_telephony_service_provider" ] } ], "summary" : "List active telephony service providers", "tags" : [ "Active Telephony Provider Configuration" ] } }, "/admin/api/v1/instance/telephony/activeProviders/{activeProviderChannel}" : { "delete" : { "description" : "You can deactivate existing telephony service provider.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_telephony_service_provider |\n", "operationId" : "deactivate", "parameters" : [ { "in" : "path", "name" : "activeProviderChannel", "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_telephony_service_provider" ] } ], "summary" : "Deactivate telephony service provider by type", "tags" : [ "Active Telephony Provider Configuration" ] }, "get" : { "description" : "You can get active telephony service provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_telephony_service_provider |\n", "operationId" : "readActiveTelephonyProvider", "parameters" : [ { "in" : "path", "name" : "activeProviderChannel", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ActiveTelephonyProviderResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "Get active telephony service provider", "tags" : [ "Active Telephony Provider Configuration" ] }, "post" : { "description" : " You can activate existing telephony service provider.\n Previously activated telephony service provider will be deactivated.\n\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_telephony_service_provider |\n", "operationId" : "activate", "parameters" : [ { "in" : "path", "name" : "activeProviderChannel", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TelephonyProvider_IdReference_InsertRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ActiveTelephonyProviderResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "Activate telephony service provider", "tags" : [ "Active Telephony Provider Configuration" ] } }, "/admin/api/v1/instance/telephony/providers" : { "get" : { "description" : "You can list existing telephony service providers by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_telephony_service_provider |\n", "operationId" : "readTelephonyProviders", "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" : { "$ref" : "#/components/schemas/PageTelephonyProviderListResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "List telephony service providers", "tags" : [ "Telephony Provider Configuration" ] }, "post" : { "description" : "You can create the existing telephony service provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_telephony_service_provider |\n", "operationId" : "createTelephonyProviders", "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "$ref" : "#/components/schemas/CustomTelephonyInsertRequest" }, { "$ref" : "#/components/schemas/InfobipInsertRequest" }, { "$ref" : "#/components/schemas/SinchInsertRequest" }, { "$ref" : "#/components/schemas/TelesignInsertRequest" }, { "$ref" : "#/components/schemas/TwilioInsertRequest" } ] } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TelephonyProviderResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "Create telephony service provider", "tags" : [ "Telephony Provider Configuration" ] } }, "/admin/api/v1/instance/telephony/providers/{providerId}" : { "delete" : { "description" : "You can delete existing telephony service provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_telephony_service_provider |\n", "operationId" : "deleteTelephonyProvider", "parameters" : [ { "in" : "path", "name" : "providerId", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_telephony_service_provider" ] } ], "summary" : "Delete telephony service provider", "tags" : [ "Telephony Provider Configuration" ] }, "get" : { "description" : "You can get existing telephony service provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_telephony_service_provider |\n", "operationId" : "readTelephonyProvider", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TelephonyProviderResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "Get telephony service provider", "tags" : [ "Telephony Provider Configuration" ] }, "put" : { "description" : "You can update existing telephony service provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_telephony_service_provider |\n", "operationId" : "updateTelephonyProvider", "parameters" : [ { "in" : "path", "name" : "providerId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "$ref" : "#/components/schemas/CustomTelephonyUpdateRequest" }, { "$ref" : "#/components/schemas/InfobipUpdateRequest" }, { "$ref" : "#/components/schemas/SinchUpdateRequest" }, { "$ref" : "#/components/schemas/TelesignUpdateRequest" }, { "$ref" : "#/components/schemas/TwilioUpdateRequest" } ] } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TelephonyProviderResponse" } } }, "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_telephony_service_provider" ] } ], "summary" : "Update telephony service provider", "tags" : [ "Telephony Provider Configuration" ] } }, "/admin/api/v1/instance/variables" : { "get" : { "description" : "You can list variables by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_variable |\n", "operationId" : "getAll", "parameters" : [ { "description" : "Type used for filtering", "in" : "query", "name" : "type", "required" : false, "schema" : { "type" : "string", "enum" : [ "variable", "secret" ] } }, { "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" : "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/PageVariableListResponse" } } }, "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_variable" ] } ], "summary" : "List variables", "tags" : [ "Variables" ] }, "post" : { "description" : "You can create a variable by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_variable |\n", "operationId" : "create_4", "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/VariableInsertRequest" }, { "$ref" : "#/components/schemas/SecretVariableInsertRequest" } ] } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariableResponse" } } }, "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_variable" ] } ], "summary" : "Create a variable", "tags" : [ "Variables" ] } }, "/admin/api/v1/instance/variables/{id}" : { "delete" : { "description" : "You can delete a variable by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_admin_variable |\n", "operationId" : "delete_6", "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" : "Variable is still in use" } }, "security" : [ { "securityScheme" : [ "delete:config_admin_variable" ] } ], "summary" : "Delete a variable", "tags" : [ "Variables" ] }, "get" : { "description" : "You can get a variable by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_variable |\n", "operationId" : "get_5", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariableResponse" } } }, "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_variable" ] } ], "summary" : "Get a variable", "tags" : [ "Variables" ] }, "put" : { "description" : "You can update a variable by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_variable |\n", "operationId" : "update_4", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "oneOf" : [ { "$ref" : "#/components/schemas/VariableUpdateRequest" }, { "$ref" : "#/components/schemas/SecretVariableUpdateRequest" } ] } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariableResponse" } } }, "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_variable" ] } ], "summary" : "Update a variable", "tags" : [ "Variables" ] } }, "/admin/api/v1/instance/webAnalytics" : { "get" : { "description" : "You can list the existing web analytics integrations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance_webanalytics |\n", "operationId" : "list_5", "parameters" : [ { "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/PageWebAnalyticsResponse_WebAnalytics" } } }, "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_instance_webanalytics" ] } ], "summary" : "List web analytics integrations", "tags" : [ "Web Analytics" ] }, "post" : { "description" : "You can create a web analytics integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance_webanalytics |\n", "operationId" : "create_3", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAnalytics_WebAnalytics" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAnalytics_WebAnalytics" } } }, "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_instance_webanalytics" ] } ], "summary" : "Create a web analytics integration", "tags" : [ "Web Analytics" ] } }, "/admin/api/v1/instance/webAnalytics/{id}" : { "delete" : { "description" : "You can delete a web analytics integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_instance_webanalytics |\n", "operationId" : "delete_5", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "enum" : [ "googleAnalytics", "googleTagManager", "mixpanel", "amplitude" ] } } ], "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_instance_webanalytics" ] } ], "summary" : "Delete a web analytics integration", "tags" : [ "Web Analytics" ] }, "get" : { "description" : "You can get a web analytics integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_instance_webanalytics |\n", "operationId" : "get_4", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "enum" : [ "googleAnalytics", "googleTagManager", "mixpanel", "amplitude" ] } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAnalyticsResponse_WebAnalytics" } } }, "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_instance_webanalytics" ] } ], "summary" : "Get a web analytics integration", "tags" : [ "Web Analytics" ] }, "put" : { "description" : "You can update a web analytics integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_instance_webanalytics |\n", "operationId" : "update_3", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string", "enum" : [ "googleAnalytics", "googleTagManager", "mixpanel", "amplitude" ] } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/WebAnalytics_WebAnalytics" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/WebAnalytics_WebAnalytics" } } }, "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_instance_webanalytics" ] } ], "summary" : "Update a web analytics integration", "tags" : [ "Web Analytics" ] } }, "/admin/api/v1/loginProviders/enterprise" : { "get" : { "description" : "You can list the enterprise login providers by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getEnterpriseLoginProviders", "parameters" : [ { "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" : "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/PageOfEnterpriseLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "List enterprise login providers", "tags" : [ "Enterprise Login Provider" ] }, "post" : { "description" : "You can create an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "createEnterpriseLoginProvider", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Generic_EnterpriseLoginProvider_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericEnterpriseLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Create an enterprise login provider", "tags" : [ "Enterprise Login Provider" ] } }, "/admin/api/v1/loginProviders/enterprise/{id}" : { "delete" : { "description" : "You can delete an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_login_provider |\n", "operationId" : "deleteEnterpriseLoginProvider", "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" : "Enterprise login provider is assigned to one or more applications or organization assignments" } }, "security" : [ { "securityScheme" : [ "delete:config_login_provider" ] } ], "summary" : "Delete an enterprise login provider", "tags" : [ "Enterprise Login Provider" ] }, "get" : { "description" : "You can get an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getEnterpriseLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericEnterpriseLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Get an enterprise login provider", "tags" : [ "Enterprise Login Provider" ] }, "put" : { "description" : "You can update an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "updateEnterpriseLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenericEnterpriseLoginProviderRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericEnterpriseLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Update an enterprise login provider", "tags" : [ "Enterprise Login Provider" ] } }, "/admin/api/v1/loginProviders/enterprise/{providerId}/availableNativeClaims" : { "get" : { "description" : "You can list the available native claims for an enterprise login provider by calling this endpoint. A native claim is listed if it's not assigned to an enterprise login provider. A native claim with name `id` will not be listed.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getNotAssignedNativeClaims_1", "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_login_provider" ] } ], "summary" : "List available native claims", "tags" : [ "Enterprise Login Claim Mapping" ] } }, "/admin/api/v1/loginProviders/enterprise/{providerId}/mappings" : { "get" : { "description" : "You can list the claim mappings for an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_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_login_provider" ] } ], "summary" : "List claim mappings", "tags" : [ "Enterprise Login Claim Mapping" ] }, "post" : { "description" : "You can create a mapping to a native claim for an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_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 enterprise login provider" } }, "security" : [ { "securityScheme" : [ "write:config_login_provider" ] } ], "summary" : "Create a claim mapping", "tags" : [ "Enterprise Login Claim Mapping" ] } }, "/admin/api/v1/loginProviders/enterprise/{providerId}/mappings/{id}" : { "delete" : { "description" : "You can delete a claim mapping for an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_login_provider |\n", "operationId" : "delete_4", "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_login_provider" ] } ], "summary" : "Delete claim mapping", "tags" : [ "Enterprise Login Claim Mapping" ] }, "get" : { "description" : "You can get a claim mapping for an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_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_login_provider" ] } ], "summary" : "Get a claim mapping", "tags" : [ "Enterprise Login Claim Mapping" ] }, "put" : { "description" : "You can update a claim mapping for an enterprise login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_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 enterprise login provider" } }, "security" : [ { "securityScheme" : [ "write:config_login_provider" ] } ], "summary" : "Update claim mapping", "tags" : [ "Enterprise Login Claim Mapping" ] } }, "/admin/api/v1/loginProviders/social" : { "get" : { "description" : "You can list the existing social login providers by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getLoginProviders", "parameters" : [ { "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" : "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/PageExternalLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "List social login providers", "tags" : [ "Social Login Provider" ] }, "post" : { "description" : "You can create a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "createLoginProvider", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Generic_SocialLoginProvider_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericSocialLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Create a social login provider", "tags" : [ "Social Login Provider" ] } }, "/admin/api/v1/loginProviders/social/{id}" : { "delete" : { "description" : "You can delete a social login provider by calling this endpoint. Social login providers assigned to applications or organization assignments cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_login_provider |\n", "operationId" : "deleteLoginProvider", "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" : "The Login provider is assigned to an application or organization assignment and couldn't be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_login_provider" ] } ], "summary" : "Delete a social login provider", "tags" : [ "Social Login Provider" ] }, "get" : { "description" : "You can get a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericSocialLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Get a social login provider", "tags" : [ "Social Login Provider" ] }, "put" : { "description" : "You can update a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "updateLoginProvider", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenericSocialLoginProviderRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericSocialLoginProviderResponse" } } }, "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_login_provider" ] } ], "summary" : "Update a social login provider", "tags" : [ "Social Login Provider" ] } }, "/admin/api/v1/loginProviders/social/{providerId}/availableNativeClaims" : { "get" : { "description" : "You can list the available native claims for a social login provider by calling this endpoint. A native claim is listed if it's not assigned to a social login provider. A native claim with name `id` will not be listed.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_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_login_provider" ] } ], "summary" : "List available native claims", "tags" : [ "Social Login Claim Mapping" ] } }, "/admin/api/v1/loginProviders/social/{providerId}/mappings" : { "get" : { "description" : "You can list the claim mappings for a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getSocialMappings", "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_login_provider" ] } ], "summary" : "List claim mappings", "tags" : [ "Social Login Claim Mapping" ] }, "post" : { "description" : "You can create a mapping to a native claim for a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "createSocialMapping", "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_login_provider" ] } ], "summary" : "Create a claim mapping", "tags" : [ "Social Login Claim Mapping" ] } }, "/admin/api/v1/loginProviders/social/{providerId}/mappings/{id}" : { "delete" : { "description" : "You can delete a claim mapping for a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_login_provider |\n", "operationId" : "delete_3", "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_login_provider" ] } ], "summary" : "Delete claim mapping", "tags" : [ "Social Login Claim Mapping" ] }, "get" : { "description" : "You can get a claim mapping for a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_login_provider |\n", "operationId" : "getSocialMapping", "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_login_provider" ] } ], "summary" : "Get a claim mapping", "tags" : [ "Social Login Claim Mapping" ] }, "put" : { "description" : "You can update a claim mapping for a social login provider by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_login_provider |\n", "operationId" : "updateSocialMapping", "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_login_provider" ] } ], "summary" : "Update claim mapping", "tags" : [ "Social Login Claim Mapping" ] } }, "/admin/api/v1/me" : { "get" : { "description" : "You can get the admin information by calling this endpoint.", "operationId" : "adminPrincipal", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PrincipalResponse_AdminPrincipal" } } }, "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" : [ ] } ], "summary" : "Get admin information", "tags" : [ "Admin Principal" ] }, "post" : { "description" : "You can update the UI settings by calling this endpoint.", "operationId" : "updateAdminPrincipal", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PrincipalUpdateRequest_AdminPrincipal" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PrincipalUpdateRequest_AdminPrincipal" } } }, "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" : [ ] } ], "summary" : "Update UI settings for admin account", "tags" : [ "Admin Principal" ] } }, "/admin/api/v1/notificationPolicies" : { "get" : { "description" : "You can list the existing notification policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_notification_policy |\n", "operationId" : "getNotificationPolicies", "parameters" : [ { "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" : "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/PageNotificationPolicyResponse_NotificationPolicy" } } }, "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_notification_policy" ] } ], "summary" : "List notification policies", "tags" : [ "Notification Policy" ] }, "post" : { "description" : "You can create a notification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_notification_policy |\n", "operationId" : "createNotificationPolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationPolicy_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationPolicyResponse_NotificationPolicy" } } }, "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_notification_policy" ] } ], "summary" : "Create a notification policy", "tags" : [ "Notification Policy" ] } }, "/admin/api/v1/notificationPolicies/{id}" : { "delete" : { "description" : "You can delete a notification policy by calling this endpoint. Notification policies assigned to applications or organization assignments cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_notification_policy |\n", "operationId" : "deleteNotificationPolicy", "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" : "Notification policy that is assigned to applications or organization assignments cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_notification_policy" ] } ], "summary" : "Delete a notification policy", "tags" : [ "Notification Policy" ] }, "get" : { "description" : "You can get a notification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_notification_policy |\n", "operationId" : "getNotificationPolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationPolicyResponse_NotificationPolicy" } } }, "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_notification_policy" ] } ], "summary" : "Get a notification policy", "tags" : [ "Notification Policy" ] }, "put" : { "description" : "You can update a notification policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_notification_policy |\n", "operationId" : "updateNotificationPolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/NotificationPolicyUpsertRequest_NotificationPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/NotificationPolicyResponse_NotificationPolicy" } } }, "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_notification_policy" ] } ], "summary" : "Update a notification policy", "tags" : [ "Notification Policy" ] } }, "/admin/api/v1/notificationPolicies/{policyId}/email/{id}" : { "put" : { "description" : "You can update a notification template for an email type and ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_notification_policy |\n", "operationId" : "updateNotificationTemplateEmail", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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/NotificationTemplateEmailUpdateRequest_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_notification_policy" ] } ], "summary" : "Update a notification template (email)", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/notificationPolicies/{policyId}/sms/{id}" : { "put" : { "description" : "You can update a notification template for an SMS type and ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_notification_policy |\n", "operationId" : "updateNotificationTemplateSMS", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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/NotificationTemplateSMSUpdateRequest_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_notification_policy" ] } ], "summary" : "Update a notification template (SMS)", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/notificationPolicies/{policyId}/{type}" : { "get" : { "description" : "You can list the existing notification templates by a notification type with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_notification_policy |\n", "operationId" : "getNotificationTemplateParameters", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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" }, "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_notification_policy" ] } ], "summary" : "List notification templates", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/notificationPolicies/{policyId}/{type}/{id}" : { "get" : { "description" : "You can get a notification template by a notification type and ID with this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_notification_policy |\n", "operationId" : "getNotificationTemplate", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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" : { "oneOf" : [ { "$ref" : "#/components/schemas/NotificationTemplateEmailUpdateRequest_NotificationTemplate" }, { "$ref" : "#/components/schemas/NotificationTemplateSMSUpdateRequest_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_notification_policy" ] } ], "summary" : "Get a notification template", "tags" : [ "Notification Template" ] } }, "/admin/api/v1/passwordPolicies" : { "get" : { "description" : "You can list the existing password quality policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "getAllPasswordPolicies", "parameters" : [ { "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" : "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/PagePasswordPolicyResponse_PasswordPolicy" } } }, "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_password_policy" ] } ], "summary" : "List password quality policies", "tags" : [ "Password Quality Policy" ] }, "post" : { "description" : "You can create a password quality policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_password_policy |\n", "operationId" : "createPasswordPolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordPolicy_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordPolicyResponse_PasswordPolicy" } } }, "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_password_policy" ] } ], "summary" : "Create a password quality policy", "tags" : [ "Password Quality Policy" ] } }, "/admin/api/v1/passwordPolicies/{id}" : { "delete" : { "description" : "You can delete a password quality policy by calling this endpoint. Password quality policies assigned to identity stores cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_password_policy |\n", "operationId" : "deletePasswordPolicy", "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" : "Policy assigned to some identity stores cannot be deleted." } }, "security" : [ { "securityScheme" : [ "delete:config_password_policy" ] } ], "summary" : "Delete a password quality policy", "tags" : [ "Password Quality Policy" ] }, "get" : { "description" : "You can get a password quality policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "getPasswordPolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordPolicyResponse_PasswordPolicy" } } }, "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_password_policy" ] } ], "summary" : "Get a password quality policy", "tags" : [ "Password Quality Policy" ] }, "put" : { "description" : "You can update a password quality policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_password_policy |\n", "operationId" : "updatePasswordPolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordPolicyUpsertRequest_PasswordPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordPolicyResponse_PasswordPolicy" } } }, "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_password_policy" ] } ], "summary" : "Update a password quality policy", "tags" : [ "Password Quality Policy" ] } }, "/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords" : { "get" : { "description" : "You can list the existing password word restrictions by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "list_4", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "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/PasswordRestrictionResponse" } } } }, "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_password_policy" ] } ], "summary" : "List password word restrictions", "tags" : [ "Restricted Password" ] }, "post" : { "description" : "You can create a password word restriction by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_password_policy |\n", "operationId" : "create_2", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionInsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionResponse" } } }, "description" : "Created" }, "400" : { "content" : { "application/json" : { "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" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Not Found" }, "409" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_password_policy" ] } ], "summary" : "Create a password word restriction", "tags" : [ "Restricted Password" ] } }, "/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/quota" : { "get" : { "description" : "Get total size in MB of all password restrictions.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "getTotalSize", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionQuotaResponse" } } }, "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_password_policy" ] } ], "summary" : "Get total size in MB", "tags" : [ "Restricted Password" ] } }, "/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}" : { "delete" : { "description" : "You can delete a password word restriction by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_password_policy |\n", "operationId" : "delete_2", "parameters" : [ { "in" : "path", "name" : "policyId", "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_password_policy" ] } ], "summary" : "Delete a password word restriction", "tags" : [ "Restricted Password" ] }, "get" : { "description" : "You can get a password word restriction by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "get_3", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionResponse" } } }, "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_password_policy" ] } ], "summary" : "Get a password word restriction", "tags" : [ "Restricted Password" ] }, "put" : { "description" : "You can update a password word restriction by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_password_policy |\n", "operationId" : "update_2", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/PasswordRestrictionResponse" } } }, "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_password_policy" ] } ], "summary" : "Update a password word restriction", "tags" : [ "Restricted Password" ] } }, "/admin/api/v1/passwordPolicies/{policyId}/restrictedPasswords/{id}/export" : { "get" : { "description" : "You can export a password restriction by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_password_policy |\n", "operationId" : "export_1", "parameters" : [ { "in" : "path", "name" : "policyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "text/plain" : { } }, "description" : "OK", "headers" : { "Content-Disposition" : { "schema" : { "type" : "string", "example" : "attachment; filename=\"{filename}\"" }, "style" : "simple" } } }, "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_password_policy" ] } ], "summary" : "Export a password restriction", "tags" : [ "Restricted Password" ] } }, "/admin/api/v1/selfServicePolicies" : { "get" : { "description" : "You can list the existing self-service policies by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_self_service_policy |\n", "operationId" : "getSelfServicePolicies", "parameters" : [ { "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" : "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/PageSelfServicePolicyResponse_SelfServicePolicy" } } }, "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_self_service_policy" ] } ], "summary" : "List self-service policies", "tags" : [ "Self Service Policy" ] }, "post" : { "description" : "You can create a self-service policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_self_service_policy |\n", "operationId" : "createSelfServicePolicy", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SelfServicePolicy_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/SelfServicePolicyResponse_SelfServicePolicy" } } }, "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_self_service_policy" ] } ], "summary" : "Create a self-service policy", "tags" : [ "Self Service Policy" ] } }, "/admin/api/v1/selfServicePolicies/{id}" : { "delete" : { "description" : "You can delete a self-service policy by calling this endpoint. Self-service policies assigned to applications or organization assignments cannot be deleted.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_self_service_policy |\n", "operationId" : "deleteSelfServicePolicyById", "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" : "The Self-service policy is assigned to applications or organization assignments and couldn't be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_self_service_policy" ] } ], "summary" : "Delete a self-service policy", "tags" : [ "Self Service Policy" ] }, "get" : { "description" : "You can get a self-service policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_self_service_policy |\n", "operationId" : "getSelfServicePolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/SelfServicePolicyResponse_SelfServicePolicy" } } }, "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_self_service_policy" ] } ], "summary" : "Get a self-service policy", "tags" : [ "Self Service Policy" ] }, "put" : { "description" : "You can update a self-service policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_self_service_policy |\n", "operationId" : "updateSelfServicePolicy", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/SelfServicePolicyUpsertRequest_SelfServicePolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/SelfServicePolicyResponse_SelfServicePolicy" } } }, "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_self_service_policy" ] } ], "summary" : "Update a self-service policy", "tags" : [ "Self Service Policy" ] } }, "/admin/api/v1/statistics/ActiveAccounts" : { "get" : { "description" : "You can query the active account statistics by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:statistic |\n", "operationId" : "queryActiveAccountsStatistics", "parameters" : [ { "in" : "query", "name" : "startDate", "required" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "in" : "query", "name" : "endDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Location in IANA time zone format.", "in" : "query", "name" : "location", "required" : false, "schema" : { "pattern" : "^\\w+/\\w+$", "type" : "string", "default" : "Etc/UTC" } }, { "description" : "Desired resolution for the the requested statistics", "in" : "query", "name" : "period", "required" : false, "schema" : { "pattern" : "^(hour|day|month|year)$", "type" : "string", "enum" : [ "hour", "day", "month", "year" ] } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/StatsResponse_Stats" } } }, "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:statistic" ] } ], "summary" : "Query active account statistics", "tags" : [ "Statistics" ] } }, "/admin/api/v1/statistics/ConnectorUptime" : { "get" : { "description" : "You can query the connector uptime statistics by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:statistic |\n", "operationId" : "queryConnectorUptimeStatistics", "parameters" : [ { "in" : "query", "name" : "identityStore", "required" : true, "schema" : { "type" : "string" } }, { "in" : "query", "name" : "startDate", "required" : true, "schema" : { "type" : "string", "format" : "date-time" } }, { "in" : "query", "name" : "endDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ConnectorUptimeEventResponse_Stats" } } } }, "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:statistic" ] } ], "summary" : "Query connector uptime statistics", "tags" : [ "Statistics" ] } }, "/admin/api/v1/statistics/ConsentAcceptance" : { "get" : { "description" : "You can query the consent acceptance statistics by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:statistic |\n", "operationId" : "queryConsentAcceptanceStatistics", "parameters" : [ { "in" : "query", "name" : "startDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "in" : "query", "name" : "endDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Location in IANA time zone format.", "in" : "query", "name" : "location", "required" : false, "schema" : { "pattern" : "^\\w+/\\w+$", "type" : "string", "default" : "Etc/UTC" } }, { "description" : "List of application ids that events should be used for the statistics", "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "interval", "required" : false, "schema" : { "pattern" : "^\\d{1,2}h$", "type" : "string", "enum" : [ "1h", "...", "99h" ] } }, { "description" : "Desired resolution for the the requested statistics", "in" : "query", "name" : "period", "required" : false, "schema" : { "pattern" : "^(hour|day|month|year)$", "type" : "string", "enum" : [ "hour", "day", "month", "year" ] } }, { "description" : "Filter against the given variant IDs or 'null'. Explicit 'null' means baseline variant.", "in" : "query", "name" : "variant", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "description" : "UUID or 'null'" } } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/StatsResponse_Stats" } } }, "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:statistic" ] } ], "summary" : "Query consent acceptance statistics", "tags" : [ "Statistics" ] } }, "/admin/api/v1/statistics/{name}" : { "get" : { "description" : "You can query statistics by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:statistic |\n", "operationId" : "queryNamedStatistics", "parameters" : [ { "in" : "path", "name" : "name", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9\\-_]+$", "type" : "string", "enum" : [ "CustomerAuthenticated", "CustomerRegistered", "ForgottenUsernameRequested", "MFAEnrollment", "PasswordReset", "FlowRun", "ExternalServiceCall", "MFAAuthentication", "AdaptiveAccess", "ResendRequest", "AccountLockout", "DisabledAccountLoginAttempt", "ConsentActivity", "ScreenTime", "ConnectorError", "ConnectorResponseTime", "EventHookExecutionTime", "EventHookErrors" ] } }, { "in" : "query", "name" : "startDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "in" : "query", "name" : "endDate", "required" : false, "schema" : { "type" : "string", "format" : "date-time" } }, { "description" : "Location in IANA time zone format.", "in" : "query", "name" : "location", "required" : false, "schema" : { "pattern" : "^\\w+/\\w+$", "type" : "string", "default" : "Etc/UTC" } }, { "in" : "query", "name" : "groupBy", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "List of application ids that events should be used for the statistics", "in" : "query", "name" : "application", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "List of client ids that events should be used for the statistics", "in" : "query", "name" : "client", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Filter by identity store names", "in" : "query", "name" : "identityStores", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Filter by hook id or ids. Supported for 'EventHookExecutionTime' and 'EventHookErrors', otherwise ignored.", "in" : "query", "name" : "hook", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "description" : "Filter by organization id or ids", "in" : "query", "name" : "organization", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" } } }, { "in" : "query", "name" : "interval", "required" : false, "schema" : { "pattern" : "^\\d{1,2}h$", "type" : "string", "enum" : [ "1h", "...", "99h" ] } }, { "description" : "Desired resolution for the the requested statistics", "in" : "query", "name" : "period", "required" : false, "schema" : { "pattern" : "^(hour|day|month|year)$", "type" : "string", "enum" : [ "hour", "day", "month", "year" ] } }, { "description" : "Filter against the given flowType. Supported for 'FlowRun', otherwise ignored.", "in" : "query", "name" : "flowType", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" }, "enum" : [ "login", "registration", "selfManagement" ] } }, { "description" : "Filter against adaptive access decision. Supported for 'AdaptiveAccess', otherwise ignored.", "in" : "query", "name" : "decision", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" }, "enum" : [ "blocking", "stepUp", "stepDown" ] } }, { "description" : "Filter against the given result.", "in" : "query", "name" : "result", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" }, "enum" : [ "success", "failure", "abandoned" ] } }, { "description" : "Filter against the given variant IDs or 'null'. Explicit 'null' means baseline variant.", "in" : "query", "name" : "variant", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string", "description" : "UUID or 'null'" } } }, { "description" : "Limits the number of returned elements. Value '0' means no limiting. Supported for 'FlowRun' and 'ScreenTime', otherwise ignored.", "in" : "query", "name" : "size", "required" : false, "schema" : { "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 } }, { "description" : "Sorting criteria in the format: value,(asc|desc). Supported for 'FlowRun' and 'ScreenTime', otherwise ignored.", "in" : "query", "name" : "sort", "required" : false, "schema" : { "pattern" : "value,(?:asc|desc)", "type" : "string" } }, { "description" : "Consent ID filter. Supported for 'ConsentActivity', otherwise ignored.", "in" : "query", "name" : "consentId", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Consent version filter, which should be used with consent ID. Supported for 'ConsentActivity', otherwise ignored.", "in" : "query", "name" : "consentVersion", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Filter against the given connector response time type. Supported for 'ConnectorResponseTime', otherwise ignored.", "in" : "query", "name" : "connectorResponseTimeType", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" }, "enum" : [ "queueTime", "datastoreResponseTime", "totalRoundTrip" ] } }, { "description" : "Filter against the given connector error type. Supported for 'ConnectorError', otherwise ignored.", "in" : "query", "name" : "connectorErrorType", "required" : false, "schema" : { "type" : "array", "items" : { "type" : "string" }, "enum" : [ "taskError", "unexpectedError" ] } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/StatsResponse_Stats" } } }, "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:statistic" ] } ], "summary" : "Query statistics", "tags" : [ "Statistics" ] } }, "/admin/api/v1/translations" : { "get" : { "description" : "You can list the translations by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_translation |\n| brand_admin |\n| api_key |\n", "operationId" : "list_3", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GenericTranslationResponse" } } } }, "description" : "| TYPE | REQUESTED WITH |\n|:----------------- | ----------------|\n| TranslationListResponse | `read:config_admin_translation` scope |\n| LanguageCodeListResponse | otherwise |" }, "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_translation", "brand_admin", "api_key" ] } ], "summary" : "List translations", "tags" : [ "Translation" ] } }, "/admin/api/v1/translations/{languageCode}" : { "delete" : { "description" : "Clears previously imported translations for the language.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_translation |\n", "operationId" : "reset", "parameters" : [ { "description" : "The format for a language code is two lowercase characters representing the language, followed by a dash and two uppercase characters representing the region.", "example" : "`fr-CA`, `fr-FR`, `ja-JP`", "in" : "path", "name" : "languageCode", "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" : "Language is not supported" } }, "security" : [ { "securityScheme" : [ "write:config_admin_translation" ] } ], "summary" : "Reset a translation", "tags" : [ "Translation" ] }, "get" : { "description" : "You can export a translation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_admin_translation |\n", "operationId" : "export", "parameters" : [ { "description" : "The format for a language code is two lowercase characters representing the language, followed by a dash and two uppercase characters representing the region.", "example" : "`en-US`, `fr-CA`, `fr-FR`, `ja-JP`", "in" : "path", "name" : "languageCode", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/TranslationJson" } } }, "description" : "OK", "headers" : { "Content-Disposition" : { "schema" : { "type" : "string", "example" : "attachment; filename=\"{filename}\"" }, "style" : "simple" } } }, "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" : "Language is not supported" } }, "security" : [ { "securityScheme" : [ "read:config_admin_translation" ] } ], "summary" : "Export a translation", "tags" : [ "Translation" ] }, "post" : { "description" : "You can import a translation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_translation |\n", "operationId" : "importTranslation", "parameters" : [ { "description" : "The format for a language code is two lowercase characters representing the language, followed by a dash and two uppercase characters representing the region.", "example" : "`fr-CA`, `fr-FR`, `ja-JP`", "in" : "path", "name" : "languageCode", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "multipart/form-data" : { "schema" : { "required" : [ "file" ], "type" : "object", "properties" : { "file" : { "type" : "string", "format" : "binary" } } } } } }, "responses" : { "200" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/TranslationJson" } } }, "description" : "OK" }, "400" : { "content" : { "application/json" : { "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" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Language is not supported" } }, "security" : [ { "securityScheme" : [ "write:config_admin_translation" ] } ], "summary" : "Import a translation", "tags" : [ "Translation" ] } }, "/admin/api/v1/translations/{languageCode}/disable" : { "post" : { "description" : "You can disable a translation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_translation |\n", "operationId" : "disableLanguage", "parameters" : [ { "description" : "The format for a language code is two lowercase characters representing the language, followed by a dash and two uppercase characters representing the region.", "example" : "`fr-CA`, `fr-FR`, `ja-JP`", "in" : "path", "name" : "languageCode", "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" : "Language is not supported" } }, "security" : [ { "securityScheme" : [ "write:config_admin_translation" ] } ], "summary" : "Disable a translation", "tags" : [ "Translation" ] } }, "/admin/api/v1/translations/{languageCode}/enable" : { "post" : { "description" : "You can enable a translation by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_admin_translation |\n", "operationId" : "enableLanguage", "parameters" : [ { "description" : "The format for a language code is two lowercase characters representing the language, followed by a dash and two uppercase characters representing the region.", "example" : "`fr-CA`, `fr-FR`, `ja-JP`", "in" : "path", "name" : "languageCode", "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" : "Language is not supported" } }, "security" : [ { "securityScheme" : [ "write:config_admin_translation" ] } ], "summary" : "Enable a translation", "tags" : [ "Translation" ] } }, "/admin/api/v2/admin/events/audit" : { "get" : { "description" : "You can list the audit logs by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_audit |\n", "operationId" : "list_2", "parameters" : [ { "description" : "URL used for filtering", "in" : "query", "name" : "url", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Specify whether the URL is an exact match or should be searched as a prefix (matching URLs that start with this value)", "in" : "query", "name" : "urlExactMatch", "required" : false, "schema" : { "type" : "boolean" } }, { "description" : "Entity type used for filtering", "in" : "query", "name" : "entityType", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Version used for filtering", "in" : "query", "name" : "version", "required" : false, "schema" : { "type" : "integer", "format" : "int32" } }, { "description" : "Name used for filtering", "in" : "query", "name" : "name", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Action used for filtering", "in" : "query", "name" : "action", "required" : false, "schema" : { "type" : "string", "enum" : [ "Create", "Update", "Delete" ] } }, { "description" : "Actor account ID used for filtering", "in" : "query", "name" : "actorAccountId", "required" : false, "schema" : { "type" : "string" } }, { "description" : "Actor IP used for filtering", "in" : "query", "name" : "actorIp", "required" : false, "schema" : { "type" : "string" } }, { "description" : "OAuth2 protocol client ID (when using client credential flow) used for filtering", "in" : "query", "name" : "actorClientId", "required" : false, "schema" : { "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" : { "$ref" : "#/components/schemas/PageAuditEntry" } } }, "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_audit" ] } ], "summary" : "List audit logs", "tags" : [ "Audit entry" ] } }, "/admin/api/v2/admin/events/audit/{id}" : { "get" : { "description" : "You can get the audit log for a given ID by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:admin_event_audit |\n", "operationId" : "get_2", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/AuditEntry" } } }, "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_audit" ] } ], "summary" : "Get an audit log", "tags" : [ "Audit entry" ] } }, "/admin/api/v2/applicationVariants" : { "get" : { "description" : "You can list all the existing variants grouped by applications.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "applicationVariants", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationVariantResponse" } } } }, "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_application" ] } ], "summary" : "List variants", "tags" : [ "Application Variant" ] } }, "/admin/api/v2/applications" : { "get" : { "description" : "You can list the existing applications by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getAllApplicationConfigs", "parameters" : [ { "description" : "Oauth2/OIDC Client ID used for filtering", "in" : "query", "name" : "oauth2ClientId", "required" : false, "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" : "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/PageApplicationConfigListResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "List applications", "tags" : [ "Application" ] }, "post" : { "description" : "You can create an application by calling this endpoint. Inactivity timeout is calculated by `inactivityTimeoutHours` * 60 + `inactivityTimeoutMinutes`\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "createApplicationConfig", "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationConfig_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApplicationConfigResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Create an application", "tags" : [ "Application" ] } }, "/admin/api/v2/applications/{appId}/organizations" : { "get" : { "description" : "You can list the existing organization policies for an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getOrganizationPolicies", "parameters" : [ { "in" : "path", "name" : "appId", "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/PageOrganizationPolicyResponse_OrganizationPolicy" } } }, "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_application" ] } ], "summary" : "List organization policies", "tags" : [ "Organization Policy" ] }, "post" : { "description" : "You can create an organization policy for an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "createOrganizationPolicy", "parameters" : [ { "in" : "path", "name" : "appId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationPolicyUpsertRequest_OrganizationPolicy" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationPolicyResponse_OrganizationPolicy" } } }, "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:config_application" ] } ], "summary" : "Create an organization policy", "tags" : [ "Organization Policy" ] } }, "/admin/api/v2/applications/{appId}/organizations/{orgId}" : { "delete" : { "description" : "You can delete an organization policy for an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "deleteOrganizationPolicy", "parameters" : [ { "in" : "path", "name" : "appId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "orgId", "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_application" ] } ], "summary" : "Delete an organization policy", "tags" : [ "Organization Policy" ] }, "get" : { "description" : "You can get an organization policy for an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getOrganizationPolicy", "parameters" : [ { "in" : "path", "name" : "appId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "orgId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationPolicyResponse_OrganizationPolicy" } } }, "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_application" ] } ], "summary" : "Get an organization policy", "tags" : [ "Organization Policy" ] }, "put" : { "description" : "You can update an organization policy for an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "updateOrganizationPolicy", "parameters" : [ { "in" : "path", "name" : "appId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "orgId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/OrganizationPolicyUpsertRequest_OrganizationPolicy" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/OrganizationPolicyResponse_OrganizationPolicy" } } }, "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_application" ] } ], "summary" : "Update an organization policy", "tags" : [ "Organization Policy" ] } }, "/admin/api/v2/applications/{applicationId}/clients" : { "get" : { "description" : "You can list the existing application clients by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getAllClients", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "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/GenericClientResponse_ApplicationConfig" } } } }, "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_application" ] } ], "summary" : "List application clients", "tags" : [ "Application Client" ] }, "post" : { "description" : "You can create an application client by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "createClient", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenericClient_InsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ModifiableClientResponse_ApplicationConfig" } } }, "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" : "Referenced application does not exist" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_application" ] } ], "summary" : "Create an application client", "tags" : [ "Application Client" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}" : { "delete" : { "description" : "You can delete an application client by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "deleteApplicationClient", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "204" : { "description" : "No Content" }, "400" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "SSP client is not removable" }, "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" : "Referenced application does not exist" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Oauth2 client has API security policy assigned to it" } }, "security" : [ { "securityScheme" : [ "write:config_application" ] } ], "summary" : "Delete an application client", "tags" : [ "Application Client" ] }, "get" : { "description" : "You can get an application client by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getClient", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericClientResponse_ApplicationConfig" } } }, "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" : "Referenced application client does not exist" } }, "security" : [ { "securityScheme" : [ "read:config_application" ] } ], "summary" : "Get an application client", "tags" : [ "Application Client" ] }, "put" : { "description" : "You can update an application client by calling this endpoint. The `name` and `loginUrl` fields for SSP clients cannot be altered.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "updateClient", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/GenericClientUpdateRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/GenericClientResponse_ApplicationConfig" } } }, "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" : "Referenced application does not exist" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Conflict" } }, "security" : [ { "securityScheme" : [ "write:config_application" ] } ], "summary" : "Update an application client", "tags" : [ "Application Client" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies" : { "get" : { "description" : "You can list bridge policies by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "list", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/BridgePolicyResponse_ApplicationConfig" } } } }, "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_application" ] } ], "summary" : "List bridge policies", "tags" : [ "Bridge Policy" ] }, "post" : { "description" : "You can create a bridge policy by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "create", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyUpsertRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResponse_ApplicationConfig" } } }, "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:config_application" ] } ], "summary" : "Create a bridge policy", "tags" : [ "Bridge Policy" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}" : { "delete" : { "description" : "You can delete a bridge policy by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "delete", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "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_application" ] } ], "summary" : "Delete a bridge policy", "tags" : [ "Bridge Policy" ] }, "get" : { "description" : "You can get a bridge policy by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "get", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Get a bridge policy", "tags" : [ "Bridge Policy" ] }, "put" : { "description" : "You can update a bridge policy by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "update", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyUpsertRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Update a bridge policy", "tags" : [ "Bridge Policy" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources" : { "get" : { "description" : "You can list bridge policy resources by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "list_1", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/BridgePolicyResourceResponse_ApplicationConfig" } } } }, "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_application" ] } ], "summary" : "List a bridge policy resources", "tags" : [ "Bridge Policy Resource" ] }, "post" : { "description" : "You can create a bridge policy resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "create_1", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResourceInsertRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResourceResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Create a bridge policy resource", "tags" : [ "Bridge Policy Resource" ] }, "put" : { "description" : "You can reorder resources by calling this endpoint. Request body should contain the existing resource IDs in the desired order.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "reOrder", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" } } } }, "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:config_application" ] } ], "summary" : "Update the order of bridge policy resources", "tags" : [ "Bridge Policy Resource" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}/bridgePolicies/{apiAccessPolicyId}/resources/{resourceId}" : { "delete" : { "description" : "You can delete a bridge resource policy by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "delete_1", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "resourceId", "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_application" ] } ], "summary" : "Delete a bridge policy resource", "tags" : [ "Bridge Policy Resource" ] }, "get" : { "description" : "You can get a bridge policy resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "get_1", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResourceResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Get a bridge policy resource", "tags" : [ "Bridge Policy Resource" ] }, "put" : { "description" : "You can update a bridge policy resource by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "update_1", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "apiAccessPolicyId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "resourceId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResourceUpdateRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/BridgePolicyResourceResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Update a bridge policy resource", "tags" : [ "Bridge Policy Resource" ] } }, "/admin/api/v2/applications/{applicationId}/clients/{clientId}/saml2/metadata/descriptor" : { "get" : { "description" : "You can get the SAML2 metadata for an application client by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getSaml2MetadataDescriptor", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "clientId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/Saml2MetadataDescriptorResponse_ApplicationConfig" } } }, "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" : "Referenced application does not exist" } }, "security" : [ { "securityScheme" : [ "read:config_application" ] } ], "summary" : "Get SAML2 metadata for an application client", "tags" : [ "Application Client" ] } }, "/admin/api/v2/applications/{applicationId}/variants" : { "get" : { "description" : "You can list the existing variants of an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "listVariants", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VariantListResponse" } } } }, "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_application" ] } ], "summary" : "List application config A/B testing variants", "tags" : [ "Application Variant" ] }, "post" : { "description" : "You can create a variant by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "createVariant", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VariantInsertRequest" } } }, "required" : true }, "responses" : { "201" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariantResponse" } } }, "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:config_application" ] } ], "summary" : "Create an application config A/B testing variant", "tags" : [ "Application Variant" ] }, "put" : { "description" : "You can reorder variants by calling this endpoint. Request body should contain the existing resource IDs in the desired order.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "reorderVariants", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest" } } } }, "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:config_application" ] } ], "summary" : "Update the order of application config A/B testing variants", "tags" : [ "Application Variant" ] } }, "/admin/api/v2/applications/{applicationId}/variants/{variantId}" : { "delete" : { "description" : "You can delete a variant by calling this endpoint\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_application |\n", "operationId" : "deleteVariant", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "variantId", "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_application" ] } ], "summary" : "Delete an application config A/B testing variant", "tags" : [ "Application Variant" ] }, "get" : { "description" : "You can get a variant by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getVariant", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "variantId", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariantResponse" } } }, "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_application" ] } ], "summary" : "Get an application config A/B testing variant", "tags" : [ "Application Variant" ] }, "put" : { "description" : "You can update a variant by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "updateVariant", "parameters" : [ { "in" : "path", "name" : "applicationId", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "variantId", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/VariantUpdateRequest" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/VariantResponse" } } }, "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_application" ] } ], "summary" : "Update an application config A/B testing variant", "tags" : [ "Application Variant" ] } }, "/admin/api/v2/applications/{id}" : { "delete" : { "description" : "You can delete an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| delete:config_application |\n", "operationId" : "deleteApplicationConfig", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "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" }, "409" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ProblemJson" } } }, "description" : "Application that has API access policy assigned to any of its clients cannot be deleted" } }, "security" : [ { "securityScheme" : [ "delete:config_application" ] } ], "summary" : "Delete an application", "tags" : [ "Application" ] }, "get" : { "description" : "You can get an application by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_application |\n", "operationId" : "getApplicationConfig", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApplicationConfigResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Get an application", "tags" : [ "Application" ] }, "put" : { "description" : "You can update an application by calling this endpoint. The application type cannot be altered.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| write:config_application |\n", "operationId" : "updateApplicationConfig", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ApplicationConfigUpsertRequest_ApplicationConfig" } } }, "required" : true }, "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/ApplicationConfigResponse_ApplicationConfig" } } }, "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_application" ] } ], "summary" : "Update an application", "tags" : [ "Application" ] } }, "/admin/api/v2/pluginLibrary/categories" : { "get" : { "description" : "You can get the available categories by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n| read:config_journey |\n", "operationId" : "getCategories", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/CategoryResponse" } } } }, "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_event_hook", "read:config_journey" ] } ], "summary" : "Get categories for plugin library", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/eventHookSnippets/{type}" : { "get" : { "description" : "You can get snippets for a specific hook type by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getSnippets", "parameters" : [ { "in" : "path", "name" : "type", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventHookSnippet" } } } }, "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_event_hook" ] } ], "summary" : "Get snippets by hook type", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/eventHookSnippets/{type}/{id}" : { "get" : { "description" : "You can get snippet code by defining the hook type and snippet ID.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getSnippetCode", "parameters" : [ { "in" : "path", "name" : "type", "required" : true, "schema" : { "type" : "string" } }, { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookSnippetCode" } } }, "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_event_hook" ] } ], "summary" : "Get snippet code", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/eventHooks" : { "get" : { "description" : "You can get the integrations for lifecycle event hooks by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getEventHooks", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EventHookIntegrationListResponse" } } } }, "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_event_hook" ] } ], "summary" : "Get plugin library for lifecycle event hooks", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/eventHooks/{id}" : { "get" : { "description" : "You can get an integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_event_hook |\n", "operationId" : "getEventHookIntegration", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/EventHookIntegrationResponse" } } }, "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_event_hook" ] } ], "summary" : "Get an integration for lifecycle event hook", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/journeys" : { "get" : { "description" : "You can get the integrations for journeys by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_journey |\n", "operationId" : "getJourneys", "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/JourneyIntegrationListResponse" } } } }, "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_journey" ] } ], "summary" : "Get plugin library for journeys", "tags" : [ "Plugin Library" ] } }, "/admin/api/v2/pluginLibrary/journeys/{id}" : { "get" : { "description" : "You can get an integration by calling this endpoint.\n\n| REQUIRED API PERMISSION |\n|:------------------------|\n| read:config_journey |\n", "operationId" : "getJourneyIntegration", "parameters" : [ { "in" : "path", "name" : "id", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "content" : { "*/*" : { "schema" : { "$ref" : "#/components/schemas/JourneyIntegrationResponse" } } }, "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_journey" ] } ], "summary" : "Get an integration for journey", "tags" : [ "Plugin Library" ] } } }, "components" : { "schemas" : { "AccountAttributeConnector_AccountAttribute" : { "type" : "object", "properties" : { "readFromPath" : { "maxLength" : 256, "minLength" : 1, "type" : "string" } }, "description" : "Represents the connector related configurations" }, "AccountAttributeTranslation" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "errorMessage" : { "type" : "string" }, "values" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "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 } } }, "AccountInsertRequest.Local_Account" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Represents the username identifier", "example" : "john22" }, "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}" } }, "description" : "Represents the local metadata for an account" }, "AccountInsertRequest.Phone_Account" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Represents the phone identifier", "example" : "+36301234567" }, "verified" : { "type" : "boolean", "default" : false } } }, "AccountInsertRequest_Account" : { "required" : [ "language" ], "type" : "object", "properties" : { "email" : { "$ref" : "#/components/schemas/AccountInsertRequest.Email_Account" }, "language" : { "pattern" : "[a-z]{2,3}-[A-Z0-9]{2,3}", "type" : "string", "default" : "en-US" }, "local" : { "$ref" : "#/components/schemas/AccountInsertRequest.Local_Account" }, "organization" : { "type" : "string", "description" : "ID of the represented organization. If not specified, the inserted account will be non-organizational." }, "password" : { "maxLength" : 256, "minLength" : 1, "type" : "string" }, "phone" : { "$ref" : "#/components/schemas/AccountInsertRequest.Phone_Account" }, "skipPasswordPolicy" : { "type" : "boolean", "default" : false }, "skipUsernameAttributeValidator" : { "type" : "boolean", "default" : false } } }, "AccountInvitationInsertRequest_AccountInvitationDetails" : { "required" : [ "clientId", "email", "groups", "language", "metadata", "roles" ], "type" : "object", "properties" : { "clientId" : { "type" : "string", "description" : "ID of the represented client" }, "email" : { "type" : "string" }, "groups" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_AccountInvitationDetails" } }, "language" : { "pattern" : "[a-z]{2,3}-[A-Z0-9]{2,3}", "type" : "string", "default" : "en-US" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents metadata for an account to be invited" }, "description" : "Represents metadata for an account to be invited" }, "organization" : { "type" : "string", "description" : "ID of the represented organization. If not specified, the invited account will be non-organizational." }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountRole_AccountInvitationDetails" } } } }, "AccountInvitationResponse_Account" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "clientId" : { "type" : "string", "description" : "ID of the represented client" }, "email" : { "type" : "string" }, "id" : { "type" : "string" }, "organization" : { "type" : "string", "description" : "ID of the represented organization. If not specified, the invited account will be non-organizational." }, "sent" : { "type" : "string", "format" : "date-time" }, "store" : { "type" : "string", "description" : "Name of the represented identity store" }, "validUntil" : { "type" : "string", "format" : "date-time" } } }, "AccountInvitationResponse_AccountInvitationDetails" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "clientId" : { "type" : "string", "description" : "ID of the represented client" }, "email" : { "type" : "string" }, "groups" : { "type" : "array", "description" : "List of group ids that are assigned to the account.", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_AccountInvitationDetails" }, "default" : [ ] }, "id" : { "type" : "string" }, "language" : { "type" : "string", "description" : "Language of the invitation", "default" : "en-US" }, "metadata" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "organization" : { "type" : "string", "description" : "ID of the represented organization. If not specified, the invited account will be non-organizational." }, "roles" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AccountRole_AccountInvitationDetails" } }, "sent" : { "type" : "string", "format" : "date-time" }, "store" : { "type" : "string", "description" : "Name of the represented identity store" }, "validUntil" : { "type" : "string", "format" : "date-time" } } }, "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" }, "AccountOrganizationUpdateRequest" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented organization. If not specified, the account will be non-organizational." } } }, "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" ] } } }, "Actions" : { "type" : "object", "properties" : { "failure" : { "type" : "string", "enum" : [ "nextStep", "failureMessage", "exitProofing" ] }, "success" : { "type" : "string", "enum" : [ "nextStep", "exitProofing" ] } } }, "ActiveTelephonyProviderResponse" : { "type" : "object", "properties" : { "channel" : { "type" : "string", "enum" : [ "sms", "voice" ] }, "id" : { "type" : "string" } } }, "Actor" : { "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "ip" : { "type" : "string" }, "userAgent" : { "type" : "string" }, "userName" : { "type" : "string" } } }, "ActorApplication" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } }, "description" : "Application in which the actor initiated the event" }, "ActorClient" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "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" }, "AdaptiveAccessPolicyRequest_AdaptiveMFA" : { "required" : [ "id", "mfa", "name", "workflow" ], "type" : "object", "properties" : { "accountLockout" : { "$ref" : "#/components/schemas/AccountLockout_AdaptiveMFA" }, "allowLehToSuppressPasswords" : { "type" : "boolean", "default" : false }, "allowPasswordResetWithEmailAttribute" : { "type" : "boolean", "default" : false }, "allowPasswordResetWithPhoneAttribute" : { "type" : "boolean", "default" : false }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "exposeAttempts" : { "type" : "boolean", "default" : false }, "externalLoginsMFAEnabled" : { "type" : "boolean", "default" : false }, "id" : { "type" : "string" }, "mfa" : { "$ref" : "#/components/schemas/MfaRequest_AdaptiveMFA" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "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\"]" ] } } }, "AdaptiveAccessPolicyResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "accountLockout" : { "$ref" : "#/components/schemas/AccountLockoutResponse_AdaptiveMFA" }, "allowLehToSuppressPasswords" : { "type" : "boolean" }, "allowPasswordResetWithEmailAttribute" : { "type" : "boolean" }, "allowPasswordResetWithPhoneAttribute" : { "type" : "boolean" }, "description" : { "type" : "string" }, "exposeAttempts" : { "type" : "boolean" }, "externalLoginsMFAEnabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "mfa" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyMFAResponse_AdaptiveMFA" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "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", "description" : "Represents a step in the login flow", "enum" : [ "username", "password", "mfa" ] } } }, "description" : "Represents an adaptive access policy" }, "AdaptiveAccessPolicy_InsertRequest" : { "required" : [ "mfa", "name", "workflow" ], "type" : "object", "properties" : { "accountLockout" : { "$ref" : "#/components/schemas/AccountLockout_AdaptiveMFA" }, "allowLehToSuppressPasswords" : { "type" : "boolean", "default" : false }, "allowPasswordResetWithEmailAttribute" : { "type" : "boolean", "default" : false }, "allowPasswordResetWithPhoneAttribute" : { "type" : "boolean", "default" : false }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "exposeAttempts" : { "type" : "boolean", "default" : false }, "externalLoginsMFAEnabled" : { "type" : "boolean", "default" : false }, "mfa" : { "$ref" : "#/components/schemas/MfaRequest_AdaptiveMFA" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "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\"]" ] } } }, "AdditionalContent_Brand" : { "type" : "object", "properties" : { "html" : { "type" : "string", "nullable" : true }, "link" : { "type" : "string", "nullable" : true } }, "description" : "Exactly one of its fields have a value other than null" }, "AdditionalContents_Brand" : { "type" : "object", "properties" : { "footer" : { "$ref" : "#/components/schemas/AdditionalContent_Brand" }, "header" : { "$ref" : "#/components/schemas/AdditionalContent_Brand" }, "left" : { "$ref" : "#/components/schemas/AdditionalContent_Brand" }, "right" : { "$ref" : "#/components/schemas/AdditionalContent_Brand" } } }, "AdditionalScripts_Brand" : { "type" : "object", "properties" : { "login" : { "type" : "string", "description" : "Additional JavaScript code that is executed on login flow initialization" }, "myaccount" : { "type" : "string", "description" : "Additional JavaScript code that is executed on My Account page load" }, "organizationPortal" : { "type" : "string", "description" : "Additional JavaScript code that is executed on Organization Portal page load" } } }, "AddressRiskEvaluationAddress" : { "required" : [ "city", "postalCode", "state", "streetAddress" ], "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" }, "postalCode" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" }, "state" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" }, "streetAddress" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" } } }, "AddressRiskEvaluationAddressResponse" : { "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" }, "postalCode" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" }, "state" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" }, "streetAddress" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" } } }, "AddressRiskEvaluationAttributeResponse" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } }, "AddressRiskEvaluationContact" : { "required" : [ "email", "phone" ], "type" : "object", "properties" : { "email" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" }, "phone" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" } } }, "AddressRiskEvaluationContactResponse" : { "type" : "object", "properties" : { "email" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" }, "phone" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" } } }, "AddressRiskEvaluationPersonal" : { "required" : [ "familyName", "givenName" ], "type" : "object", "properties" : { "familyName" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" }, "givenName" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskVerificationAttribute" } } }, "AddressRiskEvaluationPersonalResponse" : { "type" : "object", "properties" : { "familyName" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" }, "givenName" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAttributeResponse" } } }, "AddressRiskEvaluationStepConfigurationResponse" : { "type" : "object", "properties" : { "claimManagement" : { "$ref" : "#/components/schemas/ClaimManagementResponse" }, "ruleManagement" : { "$ref" : "#/components/schemas/RuleManagementResponse" } } }, "AddressRiskEvaluationStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AddressRiskEvaluationStepConfigurationResponse" } } } ] }, "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" } } } }, "ApiSecurityPolicyListResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "audience" : { "type" : "string" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" } } }, "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" } } } }, "ApiSecurityPolicyUpsertRequest_ApiAccessPolicy" : { "required" : [ "audience", "id", "name" ], "type" : "object", "properties" : { "audience" : { "maxLength" : 767, "minLength" : 1, "type" : "string" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "ApiSecurityPolicy_InsertRequest" : { "required" : [ "audience", "name" ], "type" : "object", "properties" : { "audience" : { "maxLength" : 767, "minLength" : 1, "type" : "string" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "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" } } }, "AppleLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderConfiguration" }, "description" : { "type" : "string" }, "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" } } }, "AppleLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "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 } } }, "Apple_LoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/AppleLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "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 } } }, "ApplicationClientNameAndLoginURLsResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" } } }, "ApplicationClientOAuth2ConfigurationResponse_ApplicationConfig" : { "type" : "object", "properties" : { "accessTokenFormat" : { "type" : "string", "enum" : [ "opaque", "jwt" ] }, "accessTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "backChannelLogoutUrl" : { "type" : "array", "items" : { "type" : "string" } }, "callbackUrl" : { "$ref" : "#/components/schemas/CallbackURLResponse_ApplicationConfig" }, "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" }, "customAudiences" : { "type" : "array", "items" : { "type" : "string" } }, "dialect" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "enableSelfServiceApiAccess" : { "type" : "boolean" }, "idTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "interactiveLoginEnabled" : { "type" : "boolean" }, "jwks" : { "$ref" : "#/components/schemas/JwksResponse_ApplicationConfig" }, "jwksAlgorithm" : { "type" : "string", "enum" : [ "RS256", "ES256" ] }, "jwksUri" : { "type" : "string" }, "jwtSigningMethod" : { "type" : "string", "enum" : [ "RS256" ] }, "logoutUrl" : { "$ref" : "#/components/schemas/CallbackURLResponse_ApplicationConfig" }, "refreshTokenGrantEnabled" : { "type" : "boolean" }, "refreshTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "tokenEndpointAuthMethod" : { "type" : "string", "enum" : [ "client_secret_basic", "client_secret_post", "private_key_jwt", "none" ] } } }, "ApplicationClientOAuth2NativeConfigurationResponse_ApplicationConfig" : { "type" : "object", "properties" : { "accessTokenFormat" : { "type" : "string", "enum" : [ "opaque", "jwt" ] }, "accessTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "callbackUrl" : { "$ref" : "#/components/schemas/CallbackURLResponse_ApplicationConfig" }, "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" }, "customAudiences" : { "type" : "array", "items" : { "type" : "string" } }, "dialect" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "enableSelfServiceApiAccess" : { "type" : "boolean" }, "idTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "interactiveLoginEnabled" : { "type" : "boolean" }, "jwks" : { "$ref" : "#/components/schemas/JwksResponse_ApplicationConfig" }, "jwksAlgorithm" : { "type" : "string", "enum" : [ "RS256", "ES256" ] }, "jwksUri" : { "type" : "string" }, "jwtSigningMethod" : { "type" : "string", "enum" : [ "RS256" ] }, "logoutUrl" : { "$ref" : "#/components/schemas/CallbackURLResponse_ApplicationConfig" }, "refreshTokenGrantEnabled" : { "type" : "boolean" }, "refreshTokenLifespanMinutes" : { "type" : "integer", "format" : "int32" }, "tokenEndpointAuthMethod" : { "type" : "string", "enum" : [ "none" ] } } }, "ApplicationClientOAuth2NativeConfigurationUpdateRequest_ApplicationConfig" : { "required" : [ "clientId", "clientSecret", "dialect", "jwtSigningMethod" ], "type" : "object", "properties" : { "accessTokenFormat" : { "type" : "string", "default" : "opaque", "enum" : [ "opaque", "jwt" ] }, "accessTokenLifespanMinutes" : { "maximum" : 1440, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 60 }, "callbackUrl" : { "$ref" : "#/components/schemas/CallbackURLRequest_ApplicationConfig" }, "clientId" : { "maxLength" : 36, "minLength" : 0, "type" : "string" }, "clientSecret" : { "maxLength" : 72, "minLength" : 0, "type" : "string" }, "customAudiences" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "default" : [ ] }, "dialect" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "enableSelfServiceApiAccess" : { "type" : "boolean", "default" : false }, "idTokenLifespanMinutes" : { "maximum" : 1440, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 60 }, "interactiveLoginEnabled" : { "type" : "boolean", "default" : true }, "jwks" : { "$ref" : "#/components/schemas/JwksRequest_ApplicationConfig" }, "jwksAlgorithm" : { "type" : "string", "enum" : [ "RS256", "ES256" ] }, "jwksUri" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "jwtSigningMethod" : { "type" : "string", "enum" : [ "RS256" ] }, "logoutUrl" : { "$ref" : "#/components/schemas/CallbackURLRequest_ApplicationConfig" }, "refreshTokenGrantEnabled" : { "type" : "boolean", "default" : false }, "refreshTokenLifespanMinutes" : { "maximum" : 1576800, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 43200 } } }, "ApplicationClientSaml2ConfigurationResponse_ApplicationConfig" : { "type" : "object", "properties" : { "assertionConsumerServiceUrl" : { "$ref" : "#/components/schemas/CallbackURLResponse_ApplicationConfig" }, "defaultAssertionConsumerServiceUrl" : { "type" : "string" }, "dialect" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "entityId" : { "type" : "string" }, "nameIdFormat" : { "type" : "string" }, "nameIdNativeClaim" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "relayStateHandling" : { "$ref" : "#/components/schemas/RelayStateHandlingResponse_ApplicationConfig" }, "signingCertificate" : { "type" : "string" }, "singleLogoutUrl" : { "type" : "array", "items" : { "type" : "string" } } } }, "ApplicationClientSaml2ConfigurationUpdateRequest_ApplicationConfig" : { "required" : [ "assertionConsumerServiceUrl", "defaultAssertionConsumerServiceUrl", "dialect", "nameIdFormat", "nameIdNativeClaim" ], "type" : "object", "properties" : { "assertionConsumerServiceUrl" : { "$ref" : "#/components/schemas/CallbackURLRequest_ApplicationConfig" }, "defaultAssertionConsumerServiceUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string", "description" : "Must contain one of the URLs specified in `assertionConsumerServiceUrl` list" }, "dialect" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "entityId" : { "maxLength" : 256, "minLength" : 1, "type" : "string", "description" : "The value of this field is generated when not provided" }, "nameIdFormat" : { "pattern" : "urn:oasis:names:tc:SAML:(1\\.1:nameid-format:unspecified|1\\.1:nameid-format:emailAddress|2\\.0:nameid-format:persistent|2\\.0:nameid-format:transient)", "type" : "string" }, "nameIdNativeClaim" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "relayStateHandling" : { "$ref" : "#/components/schemas/RelayStateHandling_ApplicationConfig" }, "signingCertificate" : { "maxLength" : 8192, "minLength" : 1, "type" : "string" }, "singleLogoutUrl" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "default" : [ ] } } }, "ApplicationConfigConsentRequest_ApplicationConfig" : { "type" : "object", "properties" : { "consent" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "order" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "optional", "mandatory", "mandatoryHidden" ] } }, "description" : "Consent assignment for an application" }, "ApplicationConfigConsentResponse_ApplicationConfig" : { "type" : "object", "properties" : { "consent" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "order" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "optional", "mandatory", "mandatoryHidden" ] } } }, "ApplicationConfigListResponse_ApplicationConfig" : { "type" : "object", "properties" : { "allowRememberAuthenticatorWithoutIdentifier" : { "type" : "boolean" }, "clients" : { "type" : "array", "description" : "Clients within an application config", "items" : { "$ref" : "#/components/schemas/ApplicationClientNameAndLoginURLsResponse_ApplicationConfig" } }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "identityStore" : { "$ref" : "#/components/schemas/NameReferenceResponse_ApplicationConfig" }, "inactivityTimeoutHours" : { "type" : "integer", "format" : "int32" }, "inactivityTimeoutMinutes" : { "type" : "integer", "format" : "int32" }, "keepMeLoggedIn" : { "type" : "string", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "keepMeLoggedInEnabled" : { "type" : "boolean", "deprecated" : true }, "loginSessionMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "rememberAccount" : { "type" : "string", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "rememberDeviceWithoutIdentifier" : { "type" : "boolean", "deprecated" : true }, "sessionExpirable" : { "type" : "boolean" }, "sessionMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal" ] } } }, "ApplicationConfigNotificationPolicyResponse_ApplicationConfig" : { "type" : "object", "properties" : { "id" : { "type" : "string" } } }, "ApplicationConfigResponse_ApplicationConfig" : { "type" : "object", "properties" : { "allowRememberAuthenticatorWithoutIdentifier" : { "type" : "boolean" }, "clients" : { "type" : "array", "description" : "Clients within an application config", "items" : { "$ref" : "#/components/schemas/ApplicationClientNameAndLoginURLsResponse_ApplicationConfig" } }, "consents" : { "uniqueItems" : true, "type" : "array", "description" : "Consents assigned to the application", "items" : { "$ref" : "#/components/schemas/ApplicationConfigConsentResponse_ApplicationConfig" } }, "description" : { "type" : "string" }, "eventHookFunctions" : { "uniqueItems" : true, "type" : "array", "description" : "Event hook functions assigned to the application", "items" : { "$ref" : "#/components/schemas/AssignedEventHookFunctionResponse_ApplicationConfig" } }, "groups" : { "uniqueItems" : true, "type" : "array", "description" : "Groups assigned to the application", "items" : { "$ref" : "#/components/schemas/NameAndIdResponse_ApplicationConfig" } }, "id" : { "type" : "string" }, "identityStore" : { "$ref" : "#/components/schemas/NameReferenceResponse_ApplicationConfig" }, "inactivityTimeoutHours" : { "type" : "integer", "format" : "int32" }, "inactivityTimeoutMinutes" : { "type" : "integer", "format" : "int32" }, "keepMeLoggedIn" : { "type" : "string", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "keepMeLoggedInEnabled" : { "type" : "boolean", "deprecated" : true }, "loginProviders" : { "$ref" : "#/components/schemas/LoginProvidersResponse_ApplicationConfig" }, "loginSessionMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "name" : { "type" : "string" }, "policies" : { "$ref" : "#/components/schemas/PoliciesResponse_ApplicationConfig" }, "policyTag" : { "type" : "string" }, "rememberAccount" : { "type" : "string", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "rememberDeviceWithoutIdentifier" : { "type" : "boolean", "deprecated" : true }, "sessionExpirable" : { "type" : "boolean" }, "sessionMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal" ] } } }, "ApplicationConfigUpsertRequest_ApplicationConfig" : { "required" : [ "groups", "id", "identityStore", "loginProviders", "name", "policies", "type" ], "type" : "object", "properties" : { "allowRememberAuthenticatorWithoutIdentifier" : { "type" : "boolean", "default" : false }, "consents" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationConfigConsentRequest_ApplicationConfig" } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "eventHookFunctions" : { "uniqueItems" : true, "type" : "array", "description" : "Event hook functions to be assigned to the application", "items" : { "$ref" : "#/components/schemas/EventHookAssignmentUpsertRequest_ApplicationConfig" }, "default" : [ ] }, "groups" : { "uniqueItems" : true, "type" : "array", "description" : "Group IDs (within the specified identity store) to be used for the application", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "default" : [ ] }, "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" }, "identityStore" : { "$ref" : "#/components/schemas/NameReferenceRequest_ApplicationConfig" }, "inactivityTimeoutHours" : { "maximum" : 9000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 168 }, "inactivityTimeoutMinutes" : { "maximum" : 540000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 }, "keepMeLoggedIn" : { "type" : "string", "default" : "optionalDefaultOff", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "keepMeLoggedInEnabled" : { "type" : "boolean", "writeOnly" : true, "deprecated" : true }, "loginProviders" : { "$ref" : "#/components/schemas/LoginProvidersRequest_ApplicationConfig" }, "loginSessionMaxAgeMinutes" : { "maximum" : 30, "minimum" : 5, "type" : "integer", "format" : "int32", "default" : 5 }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policies" : { "$ref" : "#/components/schemas/PoliciesRequest_ApplicationConfig" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "rememberAccount" : { "type" : "string", "default" : "always", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "rememberDeviceWithoutIdentifier" : { "type" : "boolean", "writeOnly" : true, "deprecated" : true }, "sessionExpirable" : { "type" : "boolean", "default" : false }, "sessionMaxAgeMinutes" : { "maximum" : 540000, "minimum" : 60, "type" : "integer", "format" : "int32", "default" : 43200 }, "type" : { "type" : "string", "default" : "personal", "enum" : [ "personal", "organizational", "hybrid" ] } } }, "ApplicationConfig_InsertRequest" : { "required" : [ "groups", "identityStore", "loginProviders", "name", "policies", "type" ], "type" : "object", "properties" : { "allowRememberAuthenticatorWithoutIdentifier" : { "type" : "boolean", "default" : false }, "consents" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationConfigConsentRequest_ApplicationConfig" } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "eventHookFunctions" : { "uniqueItems" : true, "type" : "array", "description" : "Event hook functions to be assigned to the application", "items" : { "$ref" : "#/components/schemas/EventHookAssignmentUpsertRequest_ApplicationConfig" }, "default" : [ ] }, "groups" : { "uniqueItems" : true, "type" : "array", "description" : "Group IDs (within the specified identity store) to be used for the application", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "default" : [ ] }, "identityStore" : { "$ref" : "#/components/schemas/NameReferenceRequest_ApplicationConfig" }, "inactivityTimeoutHours" : { "maximum" : 9000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 168 }, "inactivityTimeoutMinutes" : { "maximum" : 540000, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 }, "keepMeLoggedIn" : { "type" : "string", "default" : "optionalDefaultOff", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "keepMeLoggedInEnabled" : { "type" : "boolean", "writeOnly" : true, "deprecated" : true }, "loginProviders" : { "$ref" : "#/components/schemas/LoginProvidersRequest_ApplicationConfig" }, "loginSessionMaxAgeMinutes" : { "maximum" : 30, "minimum" : 5, "type" : "integer", "format" : "int32", "default" : 5 }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policies" : { "$ref" : "#/components/schemas/PoliciesRequest_ApplicationConfig" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "rememberAccount" : { "type" : "string", "default" : "always", "enum" : [ "always", "never", "optionalDefaultOn", "optionalDefaultOff" ] }, "rememberDeviceWithoutIdentifier" : { "type" : "boolean", "writeOnly" : true, "deprecated" : true }, "sessionExpirable" : { "type" : "boolean", "default" : false }, "sessionMaxAgeMinutes" : { "maximum" : 540000, "minimum" : 60, "type" : "integer", "format" : "int32", "default" : 43200 }, "type" : { "type" : "string", "default" : "personal", "enum" : [ "personal", "organizational", "hybrid" ] } } }, "ApplicationLauncherEntryRequest_ApplicationConfig" : { "type" : "object", "properties" : { "displayName" : { "maxLength" : 128, "minLength" : 1, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "logoUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } }, "description" : "Represents a launcher entry for an application client" }, "ApplicationLauncherEntryResponse_ApplicationConfig" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "logoUrl" : { "type" : "string" } } }, "ApplicationVariantResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "variants" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NameAndIdResponse" } } } }, "AssignedEventHookFunctionResponse" : { "type" : "object", "properties" : { "hook" : { "type" : "string", "description" : "Type of the lifecycle event hook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "variableOverrides" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/VariableOverrideResponse" } } } }, "AssignedEventHookFunctionResponse_ApplicationConfig" : { "type" : "object", "properties" : { "hook" : { "type" : "string", "description" : "Type of the lifecycle event hook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "variableOverrides" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/VariableOverrideResponse_ApplicationConfig" } } } }, "AssignedEventHookFunctionResponse_IdentityStore" : { "type" : "object", "properties" : { "hook" : { "type" : "string", "description" : "Type of the lifecycle event hook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "variableOverrides" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/VariableOverrideResponse_IdentityStore" } } } }, "AuditEntry" : { "required" : [ "id" ], "type" : "object", "properties" : { "action" : { "type" : "string" }, "actor" : { "$ref" : "#/components/schemas/Actor" }, "actorClient" : { "$ref" : "#/components/schemas/ActorClient" }, "date" : { "type" : "string", "format" : "date-time" }, "entityType" : { "type" : "string" }, "id" : { "type" : "string" }, "method" : { "type" : "string" }, "name" : { "type" : "string" }, "request" : { "type" : "string" }, "response" : { "type" : "string" }, "url" : { "type" : "string" }, "version" : { "type" : "integer", "format" : "int32" } } }, "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" }, "AvailableScopeResponse" : { "type" : "object", "properties" : { "delete" : { "type" : "string", "description" : "Delete permission for the scope" }, "name" : { "type" : "string" }, "read" : { "type" : "string", "description" : "Read permission for the scope" }, "write" : { "type" : "string", "description" : "Write permission for the scope" } }, "description" : "Represents an available scope" }, "AvailableVersion_Npm" : { "type" : "object", "properties" : { "version" : { "type" : "string", "example" : "1.0.0" } } }, "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" }, "BooleanExpressionInsert" : { "type" : "object", "properties" : { "operator" : { "type" : "string" } } }, "BooleanExpressionResponse" : { "type" : "object", "properties" : { "operator" : { "type" : "string" } } }, "BrandAdditionalContent_Brand" : { "type" : "object", "properties" : { "html" : { "maxLength" : 65536, "minLength" : 1, "type" : "string", "nullable" : true }, "link" : { "maxLength" : 1024, "minLength" : 10, "type" : "string", "nullable" : true } }, "description" : "Exactly one of its fields have a value other than null" }, "BrandAdditionalContents_Brand" : { "type" : "object", "properties" : { "footer" : { "$ref" : "#/components/schemas/BrandAdditionalContent_Brand" }, "header" : { "$ref" : "#/components/schemas/BrandAdditionalContent_Brand" }, "left" : { "$ref" : "#/components/schemas/BrandAdditionalContent_Brand" }, "right" : { "$ref" : "#/components/schemas/BrandAdditionalContent_Brand" } } }, "BrandAdditionalScripts_Brand" : { "type" : "object", "properties" : { "login" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "Additional JavaScript code that is executed on login flow initialization" }, "myaccount" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "Additional JavaScript code that is executed on My Account page load" }, "organizationPortal" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "Additional JavaScript code that is executed on Organization Portal page load" } } }, "BrandCustomCss_Brand" : { "type" : "object", "properties" : { "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" }, "organizationPortal" : { "maxLength" : 131072, "minLength" : 1, "type" : "string", "description" : "CSS code for custom styling on Organization Portal page" } } }, "BrandTranslation" : { "type" : "object", "properties" : { "additionalContents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BrandTranslationAdditionalContents" } }, "additionalTexts" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "copyright" : { "type" : "string" }, "supportText" : { "type" : "string" } } }, "BrandTranslationAdditionalContent" : { "type" : "object", "properties" : { "html" : { "type" : "string" } } }, "BrandTranslationAdditionalContents" : { "type" : "object", "properties" : { "footer" : { "$ref" : "#/components/schemas/BrandTranslationAdditionalContent" }, "header" : { "$ref" : "#/components/schemas/BrandTranslationAdditionalContent" }, "left" : { "$ref" : "#/components/schemas/BrandTranslationAdditionalContent" }, "right" : { "$ref" : "#/components/schemas/BrandTranslationAdditionalContent" } } }, "BrandUpsertRequest_Brand" : { "required" : [ "backgroundColor", "brandName", "id", "name", "primaryColor" ], "type" : "object", "properties" : { "additionalContents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BrandAdditionalContents_Brand" } }, "additionalScripts" : { "$ref" : "#/components/schemas/BrandAdditionalScripts_Brand" }, "additionalTexts" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "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." }, "brandName" : { "maxLength" : 48, "minLength" : 2, "pattern" : "^[- a-zA-Z0-9@£$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ!\"#¤%&'()*+,.\\/:;<=>?¡ÄÖÑܧ¿äöñüà]*$", "type" : "string" }, "copyright" : { "pattern" : "^((?![<>]).)+$", "type" : "string" }, "css" : { "$ref" : "#/components/schemas/BrandCustomCss_Brand" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "faviconUrl" : { "type" : "string" }, "id" : { "type" : "string" }, "logoInFooter" : { "type" : "boolean", "default" : false }, "logoUrl" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "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" }, "supportText" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" } } }, "Brand_Brand" : { "required" : [ "id" ], "type" : "object", "properties" : { "additionalContents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AdditionalContents_Brand" } }, "additionalScripts" : { "$ref" : "#/components/schemas/AdditionalScripts_Brand" }, "additionalTexts" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "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." }, "brandName" : { "type" : "string" }, "copyright" : { "type" : "string" }, "css" : { "$ref" : "#/components/schemas/BrandingCustomCss_Brand" }, "default" : { "type" : "boolean" }, "description" : { "type" : "string" }, "faviconUrl" : { "type" : "string" }, "id" : { "type" : "string" }, "logoInFooter" : { "type" : "boolean", "default" : false }, "logoUrl" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "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" : { "type" : "string" }, "siteTermsUrl" : { "type" : "string" }, "supportText" : { "type" : "string" } } }, "Brand_InsertRequest" : { "required" : [ "backgroundColor", "brandName", "name", "primaryColor" ], "type" : "object", "properties" : { "additionalContents" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BrandAdditionalContents_Brand" } }, "additionalScripts" : { "$ref" : "#/components/schemas/BrandAdditionalScripts_Brand" }, "additionalTexts" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "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." }, "brandName" : { "maxLength" : 48, "minLength" : 2, "pattern" : "^[- a-zA-Z0-9@£$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ!\"#¤%&'()*+,.\\/:;<=>?¡ÄÖÑܧ¿äöñüà]*$", "type" : "string" }, "copyright" : { "pattern" : "^((?![<>]).)+$", "type" : "string" }, "css" : { "$ref" : "#/components/schemas/BrandCustomCss_Brand" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "faviconUrl" : { "type" : "string" }, "logoInFooter" : { "type" : "boolean", "default" : false }, "logoUrl" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "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" }, "supportText" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^((?![<>]).)*$", "type" : "string" } } }, "BrandingCustomCss_Brand" : { "type" : "object", "properties" : { "login" : { "type" : "string", "description" : "CSS code for custom styling on login flow" }, "myaccount" : { "type" : "string", "description" : "CSS code for custom styling on myaccount" }, "organizationPortal" : { "type" : "string", "description" : "CSS code for custom styling on Organization Portal page" } } }, "BridgeClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientOAuth2ConfigurationResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "BridgeClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/OAuth2Configuration_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "BridgePolicyResourceInsertRequest_ApplicationConfig" : { "required" : [ "authentication", "methods", "pathPattern" ], "type" : "object", "properties" : { "authentication" : { "$ref" : "#/components/schemas/BridgePolicyResourceRequest.Authentication_ApplicationConfig" }, "methods" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "items" : { "pattern" : "^(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH)$", "type" : "string" } }, "pathPattern" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" } } }, "BridgePolicyResourceRequest.Authentication_ApplicationConfig" : { "required" : [ "authorizationScopes" ], "type" : "object", "properties" : { "authorizationScopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" } }, "required" : { "type" : "boolean", "default" : true } } }, "BridgePolicyResourceResponse.Authentication_ApplicationConfig" : { "type" : "object", "properties" : { "authorizationScopes" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" } }, "required" : { "type" : "boolean" } } }, "BridgePolicyResourceResponse_ApplicationConfig" : { "type" : "object", "properties" : { "authentication" : { "$ref" : "#/components/schemas/BridgePolicyResourceResponse.Authentication_ApplicationConfig" }, "id" : { "type" : "string" }, "methods" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "pathPattern" : { "type" : "string" } } }, "BridgePolicyResourceUpdateRequest_ApplicationConfig" : { "required" : [ "authentication", "id", "methods", "pathPattern" ], "type" : "object", "properties" : { "authentication" : { "$ref" : "#/components/schemas/BridgePolicyResourceRequest.Authentication_ApplicationConfig" }, "id" : { "type" : "string" }, "methods" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "items" : { "pattern" : "^(GET|HEAD|POST|PUT|DELETE|CONNECT|OPTIONS|TRACE|PATCH)$", "type" : "string" } }, "pathPattern" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" } } }, "BridgePolicyResponse.Header_ApplicationConfig" : { "type" : "object", "properties" : { "idTokenClaim" : { "type" : "string" }, "key" : { "type" : "string" } }, "description" : "Forwards a value to upstream server from id_token under the specified key" }, "BridgePolicyResponse_ApplicationConfig" : { "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "headers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/BridgePolicyResponse.Header_ApplicationConfig" } }, "healthMonitoringPath" : { "type" : "string" }, "upstreamUrlPath" : { "type" : "string" }, "upstreamUrls" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "BridgePolicyUpsertRequest.Header_ApplicationConfig" : { "required" : [ "idTokenClaim", "key" ], "type" : "object", "properties" : { "idTokenClaim" : { "type" : "string" }, "key" : { "type" : "string" } }, "description" : "Forwards a value to upstream server from id_token under the specified key" }, "BridgePolicyUpsertRequest_ApplicationConfig" : { "required" : [ "apiAccessPolicy", "headers", "upstreamUrls" ], "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "headers" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/BridgePolicyUpsertRequest.Header_ApplicationConfig" } }, "healthMonitoringPath" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "Must start with `/`. Expect a HTTP 200 OK response on this path on the upstream server." }, "upstreamUrlPath" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "Must start with `/` and must not end with `/`." }, "upstreamUrls" : { "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 0, "type" : "string", "description" : "Must start with `http(s)://` and must not contain path, query or fragment part. An optional port can be specified." } } } }, "BulkOperationErrorEntry" : { "type" : "object", "properties" : { "error" : { "type" : "object", "additionalProperties" : { "type" : "object" } }, "line" : { "type" : "integer", "format" : "int32" }, "request" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "BulkStatus" : { "type" : "object", "properties" : { "endDate" : { "type" : "string" }, "id" : { "type" : "string" }, "result" : { "$ref" : "#/components/schemas/Result" }, "startDate" : { "type" : "string" }, "status" : { "type" : "string" } } }, "CallTryOutEventHookRequest_EventHookFunction" : { "required" : [ "code", "requestBody" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "JavaScript code to be executed for the event hook function" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" }, "requestBody" : { "type" : "object", "description" : "Request body for the tryout function" } } }, "CallbackURLRequest_ApplicationConfig" : { "required" : [ "whitelist" ], "type" : "object", "properties" : { "whitelist" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" } } } }, "CallbackURLResponse_ApplicationConfig" : { "type" : "object", "properties" : { "whitelist" : { "type" : "array", "items" : { "type" : "string" } } } }, "CategoryResponse" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "name" : { "type" : "string" } } }, "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 } } } ] }, "Checkbox_AccountAttribute_InsertRequest" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a checkbox type attribute", "allOf" : [ { "required" : [ "displayName", "frontendHook", "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" }, "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" } }, { "type" : "object", "properties" : { "default" : { "type" : "boolean", "default" : false } } } ] }, "ClaimInsertRequest_Claim" : { "required" : [ "name", "nativeClaim" ], "type" : "object", "properties" : { "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z][a-zA-Z0-9_!#$&'()*+,\\/:;=?@\\[\\].]*$", "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/IdReferenceRequest_Claim" } } }, "ClaimManagement" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAddress" }, "contact" : { "$ref" : "#/components/schemas/AddressRiskEvaluationContact" }, "personal" : { "$ref" : "#/components/schemas/AddressRiskEvaluationPersonal" } } }, "ClaimManagementResponse" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/AddressRiskEvaluationAddressResponse" }, "contact" : { "$ref" : "#/components/schemas/AddressRiskEvaluationContactResponse" }, "personal" : { "$ref" : "#/components/schemas/AddressRiskEvaluationPersonalResponse" } } }, "ClaimResponse_Claim" : { "type" : "object", "properties" : { "dialectUri" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName_Claim" } } }, "ClaimUpdateRequest_Claim" : { "required" : [ "id", "name", "nativeClaim" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z][a-zA-Z0-9_!#$&'()*+,\\/:;=?@\\[\\].]*$", "type" : "string" }, "nativeClaim" : { "$ref" : "#/components/schemas/IdReferenceRequest_Claim" } } }, "CompoundAddressFieldConfigurationUpsertRequest" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/CompoundAddressItem" }, "city" : { "$ref" : "#/components/schemas/CompoundAddressItem" }, "country" : { "$ref" : "#/components/schemas/CompoundAddressItem" }, "postalCode" : { "$ref" : "#/components/schemas/CompoundAddressItem" }, "province" : { "$ref" : "#/components/schemas/CompoundAddressItem" } } }, "CompoundAddressItem" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "required" : { "type" : "boolean" } } }, "ConfigurationResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "maxFailedAttempts" : { "type" : "integer", "format" : "int32" } }, "description" : "Session termination settings response" }, "ConnectorUptimeEventResponse_Stats" : { "type" : "object", "properties" : { "end" : { "type" : "string", "format" : "date-time" }, "start" : { "type" : "string", "format" : "date-time" }, "type" : { "type" : "string" } } }, "Consent" : { "type" : "object", "properties" : { "consent" : { "$ref" : "#/components/schemas/IdReferenceResponse" }, "type" : { "type" : "string", "enum" : [ "optional", "mandatory", "mandatoryHidden" ] } } }, "ConsentOverride" : { "required" : [ "consent" ], "type" : "object", "properties" : { "consent" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "type" : { "type" : "string", "enum" : [ "optional", "mandatory", "mandatoryHidden" ] } } }, "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" } } }, "ConsentTranslation" : { "type" : "object", "properties" : { "displayText" : { "type" : "string" }, "selfServiceDisplayText" : { "type" : "string" } } }, "ConsentUpsertRequest_Consent" : { "required" : [ "displayText", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "displayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string", "description" : "Represents the consent statement" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "selfServiceDisplayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string", "description" : "Represents the consent statement on the self-service page" }, "version" : { "type" : "integer", "format" : "int32", "default" : 1 } } }, "Consent_Consent" : { "required" : [ "id" ], "type" : "object", "properties" : { "description" : { "type" : "string" }, "displayText" : { "type" : "string", "description" : "Represents the consent statement" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "selfServiceDisplayText" : { "type" : "string", "description" : "Represents the consent statement on the self-service page" }, "version" : { "type" : "integer", "format" : "int32", "default" : 1 } } }, "Consent_InsertRequest" : { "required" : [ "displayText", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "displayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string", "description" : "Represents the consent statement" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "selfServiceDisplayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string", "description" : "Represents the consent statement on the self-service page" }, "version" : { "type" : "integer", "format" : "int32", "default" : 1 } } }, "Credentials" : { "type" : "object", "properties" : { "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" } } }, "Credentials_IdentityStore" : { "type" : "object", "properties" : { "clientId" : { "type" : "string" }, "clientSecret" : { "type" : "string" } } }, "CustomTelephonyInsertRequest" : { "required" : [ "configuration", "name", "supportedChannels", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/CustomTelephonyInsertRequestConfiguration" }, "supportedChannels" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "sms", "voice" ] } } } } ] }, "CustomTelephonyInsertRequestConfiguration" : { "required" : [ "packageDependencies" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the custom telephony provider, if not specified it's generated automatically for each type", "default" : "*example code*" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" } } }, "CustomTelephonyUpdateRequest" : { "required" : [ "configuration", "id", "name", "supportedChannels", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/CustomTelephonyUpdateRequestConfiguration" }, "supportedChannels" : { "maxItems" : 2147483647, "minItems" : 1, "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "sms", "voice" ] } } } } ] }, "CustomTelephonyUpdateRequestConfiguration" : { "required" : [ "packageDependencies" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the custom telephony provider, if not specified it's generated automatically for each type", "default" : "*example code*" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" } } }, "CustomerIdentityVerificationInsertRequest_AccountProofing" : { "required" : [ "policyId" ], "type" : "object", "properties" : { "policyId" : { "type" : "string" } } }, "CustomerIdentityVerificationResponse_AccountProofing" : { "type" : "object", "properties" : { "attempts" : { "type" : "integer", "format" : "int64" }, "id" : { "type" : "string", "format" : "uuid" }, "invalidatedAt" : { "type" : "string", "format" : "date-time" }, "policyId" : { "type" : "string" }, "proofedAt" : { "type" : "string", "format" : "date-time" } }, "description" : "Represents an identity verification" }, "DataSourceResponse" : { "type" : "object", "properties" : { "failureCriteria" : { "type" : "string", "enum" : [ "exactMatch", "highPartialMatch", "partialMatch" ] }, "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" }, "thresholdAction" : { "type" : "string", "enum" : [ "none", "mandatoryToPass", "failureCount" ] } } }, "DataSources" : { "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "countryCode" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "dateOfBirth" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "familyName" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "givenName" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "nationalId" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "postalCode" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "state" : { "$ref" : "#/components/schemas/DataSourceResponse" }, "streetAddress" : { "$ref" : "#/components/schemas/DataSourceResponse" } } }, "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" }, "Date_AccountAttribute_InsertRequest" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "renderType", "type" ], "type" : "object", "description" : "Represents a date type attribute", "allOf" : [ { "required" : [ "displayName", "frontendHook", "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" }, "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" } }, { "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" } } } ] }, "DefaultValueRequest_EventHookFunction" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } }, "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/NoValueRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticVariableRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticSecretRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/VariableReferenceRequest_EventHookFunction" } ] }, "DefaultValueResponse_EventHookFunction" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } }, "oneOf" : [ { "$ref" : "#/components/schemas/NoValueResponse_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticVariableResponse_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticSecretResponse_EventHookFunction" }, { "$ref" : "#/components/schemas/VariableReferenceResponse_EventHookFunction" } ] }, "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" }, "DialectReference_Dialect" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "DialectResponse_Dialect" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "dialectUri" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" } } }, "DialectUpdateRequest_Dialect" : { "required" : [ "dialectUri", "id", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "dialectUri" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "DialectUpsertRequest_Dialect" : { "required" : [ "dialectUri", "id", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "dialect" : { "$ref" : "#/components/schemas/DialectReference_Dialect" }, "dialectUri" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "Dialect_InsertRequest" : { "required" : [ "dialectUri", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "dialect" : { "$ref" : "#/components/schemas/DialectReference_Dialect" }, "dialectUri" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "DisableAccountOperationRequest" : { "required" : [ "accountId", "identityStore", "operation" ], "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "operation" : { "type" : "string", "enum" : [ "disableAccount" ] } } }, "DisplayNameAndIdResponse" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "id" : { "type" : "string" } } }, "DisplayTextResponse_IdentityProofing" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "text" : { "type" : "string" } } }, "DisplayText_IdentityProofing" : { "required" : [ "text" ], "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "text" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string" } } }, "DocumentVerificationAddress" : { "required" : [ "address", "city", "country", "postalCode", "state", "streetAddress" ], "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "city" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "country" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "postalCode" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "state" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "streetAddress" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" } } }, "DocumentVerificationAddressResponse" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "city" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "country" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "postalCode" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "state" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "streetAddress" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" } } }, "DocumentVerificationAttributeResponse" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } }, "DocumentVerificationDocument" : { "required" : [ "className", "expirationDate", "issueDate", "issuerCode", "issuerName", "name", "number" ], "type" : "object", "properties" : { "className" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "expirationDate" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "issueDate" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "issuerCode" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "issuerName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "name" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "number" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" } } }, "DocumentVerificationDocumentResponse" : { "type" : "object", "properties" : { "className" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "expirationDate" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "issueDate" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "issuerCode" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "issuerName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "name" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "number" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" } } }, "DocumentVerificationPersonal" : { "required" : [ "dateOfBirth", "familyName", "firstName", "fullName", "gender", "givenName", "middleName" ], "type" : "object", "properties" : { "dateOfBirth" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "familyName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "firstName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "fullName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "gender" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "givenName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" }, "middleName" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentVerificationAttribute" } } }, "DocumentVerificationPersonalResponse" : { "type" : "object", "properties" : { "dateOfBirth" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "familyName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "firstName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "fullName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "gender" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "givenName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" }, "middleName" : { "$ref" : "#/components/schemas/DocumentVerificationAttributeResponse" } } }, "DocumentVerificationStepConfigurationResponse" : { "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/DocumentVerificationAddressResponse" }, "document" : { "$ref" : "#/components/schemas/DocumentVerificationDocumentResponse" }, "personal" : { "$ref" : "#/components/schemas/DocumentVerificationPersonalResponse" } } }, "DocumentVerificationStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/DocumentVerificationStepConfigurationResponse" } } } ] }, "ElasticsearchConfiguration" : { "type" : "object", "properties" : { "index" : { "type" : "string" }, "url" : { "type" : "string" } } }, "ElasticsearchEventStreamingInsertRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/ElasticsearchEventStreamingInsertRequest.Configuration" } } } ] }, "ElasticsearchEventStreamingInsertRequest.Configuration" : { "required" : [ "apiKey", "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "index" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "type" : "string" } } }, "ElasticsearchEventStreamingUpdateRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/ElasticsearchEventStreamingUpdateRequest.Configuration" } } } ] }, "ElasticsearchEventStreamingUpdateRequest.Configuration" : { "required" : [ "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "index" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "type" : "string" } } }, "EmailConfigResponse_InstanceConfig" : { "type" : "object", "properties" : { "connectionType" : { "type" : "string" }, "customSenderDomain" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "port" : { "type" : "integer", "format" : "int32" }, "server" : { "type" : "string" }, "username" : { "type" : "string" } } }, "EmailConfigUpdateRequest_InstanceConfig" : { "type" : "object", "properties" : { "connectionType" : { "pattern" : "^SMTPS|StartTLS$", "type" : "string", "description" : "Should not be null when enabled.", "nullable" : true, "enum" : [ "SMTPS", "StartTLS", "null" ] }, "customSenderDomain" : { "maxLength" : 512, "minLength" : 3, "type" : "string", "description" : "Override sender email domain with a custom value" }, "enabled" : { "type" : "boolean", "description" : "When disabled and both `username` and `password` fields are null then both get cleared.", "default" : false }, "password" : { "maxLength" : 255, "minLength" : 1, "type" : "string", "description" : "If `password` field was previously set then it will not be overridden unless provided." }, "port" : { "maximum" : 65535, "minimum" : 0, "type" : "integer", "format" : "int32", "default" : 0 }, "server" : { "maxLength" : 255, "minLength" : 1, "type" : "string", "description" : "Should not be null when enabled." }, "username" : { "maxLength" : 255, "minLength" : 1, "type" : "string", "description" : "Should not be null when enabled." } } }, "EnableAccountOperationRequest" : { "required" : [ "accountId", "identityStore", "operation" ], "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "operation" : { "type" : "string", "enum" : [ "enableAccount" ] } } }, "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" }, "EventHookAssignmentUpsertRequest_ApplicationConfig" : { "required" : [ "hook", "id" ], "type" : "object", "properties" : { "hook" : { "type" : "string", "description" : "Type of the eventhook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" }, "variableOverrides" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_ApplicationConfig" }, { "$ref" : "#/components/schemas/NoValueRequest_ApplicationConfig" }, { "$ref" : "#/components/schemas/StaticSecretRequest_ApplicationConfig" }, { "$ref" : "#/components/schemas/StaticVariableRequest_ApplicationConfig" }, { "$ref" : "#/components/schemas/VariableReferenceRequest_ApplicationConfig" } ] } } } }, "EventHookAssignmentUpsertRequest_IdentityStore" : { "required" : [ "hook", "id" ], "type" : "object", "properties" : { "hook" : { "type" : "string", "description" : "Type of the eventhook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" }, "variableOverrides" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_IdentityStore" }, { "$ref" : "#/components/schemas/NoValueRequest_IdentityStore" }, { "$ref" : "#/components/schemas/StaticSecretRequest_IdentityStore" }, { "$ref" : "#/components/schemas/StaticVariableRequest_IdentityStore" }, { "$ref" : "#/components/schemas/VariableReferenceRequest_IdentityStore" } ] } } } }, "EventHookDescriptorResponse_EventHookDescriptor" : { "type" : "object", "properties" : { "blocking" : { "type" : "string", "enum" : [ "YES", "NO", "USER_DEFINED" ] }, "count" : { "type" : "integer", "format" : "int64" }, "name" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "target" : { "type" : "string", "enum" : [ "application", "identityStore" ] } }, "description" : "Represents a descriptor for a lifecycle event hook" }, "EventHookFunctionListItemResponse_EventHookFunction" : { "type" : "object", "properties" : { "blocking" : { "type" : "boolean" }, "description" : { "type" : "string" }, "hook" : { "type" : "string", "description" : "Type of the event hook", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "UPGRADING", "UNHEALTHY", "NOT_RUNNING", "NON_DEPLOYED" ] } } }, "EventHookFunctionRequest_EventHookFunction" : { "required" : [ "blocking", "hook", "name", "packageDependencies" ], "type" : "object", "properties" : { "blocking" : { "type" : "boolean" }, "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the event hook function, if not specified it's generated automatically for each type", "default" : "*example code*" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "hook" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "requestBody" : { "maxLength" : 8000, "minLength" : 1, "type" : "string", "default" : "*example code*" }, "variables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HookVariableUpsertRequest_EventHookFunction" } } }, "description" : "Represents an event hook function" }, "EventHookFunctionResponse_EventHookFunction" : { "type" : "object", "properties" : { "blocking" : { "type" : "boolean" }, "code" : { "type" : "string" }, "description" : { "type" : "string" }, "hook" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "policyTag" : { "type" : "string" }, "requestBody" : { "type" : "string" }, "variables" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/HookVariableResponse_EventHookFunction" } } } }, "EventHookFunctionWithStatusResponse_EventHookFunction" : { "type" : "object", "properties" : { "blocking" : { "type" : "boolean" }, "code" : { "type" : "string" }, "description" : { "type" : "string" }, "hook" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "policyTag" : { "type" : "string" }, "requestBody" : { "type" : "string" }, "status" : { "type" : "string", "enum" : [ "ACTIVE", "UPGRADING", "UNHEALTHY", "NOT_RUNNING", "NON_DEPLOYED" ] }, "variables" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/HookVariableResponse_EventHookFunction" } } } }, "EventHookFunction_InsertRequest" : { "required" : [ "blocking", "hook", "name", "packageDependencies" ], "type" : "object", "properties" : { "blocking" : { "type" : "boolean" }, "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Code of the event hook function, if not specified it's generated automatically for each type", "default" : "*example code*" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "hook" : { "type" : "string", "enum" : [ "DENY_AUTHENTICATION", "UNIDENTIFIED_USER", "POST_ACCOUNT_LOGIN", "POST_CONSENT_UPDATE", "POST_ID_PROOFING", "POST_IDENTIFICATION", "POST_MFA_FACTOR_CHANGE", "POST_REGISTRATION", "POST_EXTERNAL_LOGIN", "POST_TOKEN_REFRESH", "PRE_ID_PROOFING", "PRE_ID_TOKEN_GENERATION", "PRE_SAML2_ASSERTION_GENERATION", "PRE_PROGRESSIVE_PROFILING", "PRE_REGISTRATION", "PRE_PASSWORD", "PRE_PASSWORD_RESET", "PRE_MULTI_STAGE_REGISTRATION", "PRE_EXTERNAL_REGISTRATION", "PRE_AUTHENTICATOR_ENROLLMENT", "PRE_PASSWORD_PERSIST", "POST_ACCOUNT_DELETION", "POST_ACCOUNT_UPDATE" ] }, "name" : { "maxLength" : 64, "minLength" : 3, "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "requestBody" : { "maxLength" : 8000, "minLength" : 1, "type" : "string", "default" : "*example code*" }, "variables" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/HookVariableUpsertRequest_EventHookFunction" } } }, "description" : "Represents an event hook function" }, "EventHookIntegrationListResponse" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "maintainer" : { "type" : "string" }, "summary" : { "type" : "string" } } }, "EventHookIntegrationResponse" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "hooks" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/LifecycleEventHook" } }, "logoUrl" : { "type" : "string" }, "maintainer" : { "type" : "string" }, "summary" : { "type" : "string" } } }, "EventHookLogListResponse" : { "type" : "object", "properties" : { "accountEventId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "application" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "client" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "hook" : { "$ref" : "#/components/schemas/HookInfoResponse" }, "id" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "logSummary" : { "$ref" : "#/components/schemas/LogSummaryResponse" }, "timestamp" : { "type" : "string" } } }, "EventHookLogResponse" : { "type" : "object", "properties" : { "accountEventId" : { "type" : "string" }, "accountId" : { "type" : "string" }, "application" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "client" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "hook" : { "$ref" : "#/components/schemas/HookInfoResponse" }, "id" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "logSummary" : { "$ref" : "#/components/schemas/LogSummaryResponse" }, "logs" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/LogListResponse" } }, "timestamp" : { "type" : "string" } } }, "EventHookOverride" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "variableOverrides" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/VariableOverrideResponse" } } } }, "EventHookSnippet" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" } }, "description" : "Represents a snippet for an event hook" }, "EventHookSnippetCode" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "description" : "Represents the code of the snippet" }, "EventHookStatusResponse_EventHookFunction" : { "type" : "object", "properties" : { "status" : { "type" : "string", "enum" : [ "ACTIVE", "UPGRADING", "UNHEALTHY", "NOT_RUNNING", "NON_DEPLOYED" ] } } }, "EventStreamingInsertRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "eventHookLogStreaming", "name", "type" ], "type" : "object", "properties" : { "accountEventStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.AccountEventStreaming" }, "auditLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.AuditLogStreaming" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean" }, "eventHookLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.EventHookLogStreaming" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string" } }, "description" : "Represents an event streaming configuration", "discriminator" : { "propertyName" : "type" } }, "EventStreamingInsertRequest.AccountEventStreaming" : { "required" : [ "nativeClaims" ], "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "nativeClaims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest" } } } }, "EventStreamingInsertRequest.AuditLogStreaming" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "EventStreamingInsertRequest.EventHookLogStreaming" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "EventStreamingResponse" : { "type" : "object", "properties" : { "accountEventStreaming" : { "$ref" : "#/components/schemas/EventStreamingResponse.AccountEventStreaming" }, "auditLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingResponse.AuditLogStreaming" }, "configuration" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/SplunkConfiguration" }, { "$ref" : "#/components/schemas/ElasticsearchConfiguration" }, { "$ref" : "#/components/schemas/HttpsConfiguration" } ] }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "eventHookLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingResponse.EventHookLogStreaming" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "splunk", "elasticsearch", "https" ] } }, "description" : "Represents an event streaming configuration" }, "EventStreamingResponse.AccountEventStreaming" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "nativeClaims" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/OnlyIdResponse" } } } }, "EventStreamingResponse.AuditLogStreaming" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "EventStreamingResponse.EventHookLogStreaming" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "EventStreamingTestResponse" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "headers" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "statusCode" : { "type" : "integer", "format" : "int32" } }, "description" : "The response from the tested event streaming endpoint" }, "EventStreamingUpdateRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "eventHookLogStreaming", "id", "name", "type" ], "type" : "object", "properties" : { "accountEventStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.AccountEventStreaming" }, "auditLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.AuditLogStreaming" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean" }, "eventHookLogStreaming" : { "$ref" : "#/components/schemas/EventStreamingInsertRequest.EventHookLogStreaming" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string" } }, "description" : "Represents an event streaming configuration", "discriminator" : { "propertyName" : "type" } }, "ExecutionStatus" : { "type" : "object", "properties" : { "affectedAccount" : { "type" : "integer", "format" : "int32" }, "end" : { "type" : "string", "format" : "date-time" }, "error" : { "type" : "string" }, "start" : { "type" : "string", "format" : "date-time" }, "status" : { "type" : "string" } } }, "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" } } }, "ExternalLoginProviderResponse" : { "type" : "object", "properties" : { "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" } } }, "ExternalLoginProviderTranslation" : { "type" : "object", "properties" : { "loginButtonText" : { "type" : "string" } } }, "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" }, "FailureMessageResponse_IdentityProofing" : { "type" : "object", "properties" : { "displayText" : { "type" : "string" } } }, "FailureMessage_IdentityProofing" : { "required" : [ "displayText" ], "type" : "object", "properties" : { "displayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string" } }, "description" : "Represents a text to display on failed identity verification" }, "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" } } }, "Filter" : { "type" : "object", "properties" : { "attributes" : { "type" : "object", "additionalProperties" : { "type" : "string" }, "writeOnly" : true }, "createdAtEndDate" : { "type" : "string" }, "createdAtStartDate" : { "type" : "string" }, "disabledAtEndDate" : { "type" : "string" }, "disabledAtStartDate" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "groups" : { "type" : "string" }, "groupsFilter" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "lastLoginAtEndDate" : { "type" : "string" }, "lastLoginAtStartDate" : { "type" : "string" }, "neverLoggedIn" : { "type" : "boolean" }, "organization" : { "type" : "string" }, "roles" : { "type" : "string" }, "rolesFilter" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "updatedAtEndDate" : { "type" : "string" }, "updatedAtStartDate" : { "type" : "string" } } }, "FilterRequest" : { "type" : "object", "properties" : { "createdAtEndDate" : { "type" : "string" }, "createdAtStartDate" : { "type" : "string" }, "disabledAtEndDate" : { "type" : "string" }, "disabledAtStartDate" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "groups" : { "type" : "string" }, "groupsFilter" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "lastLoginAtEndDate" : { "type" : "string" }, "lastLoginAtStartDate" : { "type" : "string" }, "neverLoggedIn" : { "type" : "boolean" }, "organization" : { "type" : "string" }, "roles" : { "type" : "string" }, "rolesFilter" : { "type" : "string", "enum" : [ "include", "exclude" ] }, "updatedAtEndDate" : { "type" : "string" }, "updatedAtStartDate" : { "type" : "string" } }, "description" : "Represents a filter that targets accounts affected by this rule" }, "ForbiddenPhoneTypesResponse" : { "type" : "object", "properties" : { "fixedVoip" : { "type" : "boolean" }, "landLine" : { "type" : "boolean" }, "mobile" : { "type" : "boolean" }, "nonFixedVoip" : { "type" : "boolean" }, "other" : { "type" : "boolean" } } }, "FrontendHook_AccountAttribute" : { "type" : "object", "properties" : { "code" : { "maxLength" : 32000, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false } }, "description" : "Represents a frontend hook" }, "FunctionCallResponse_EventHookFunction" : { "type" : "object", "properties" : { "body" : { "type" : "object" }, "status" : { "type" : "integer", "format" : "int32" } } }, "GenericClientInsert_ApplicationConfig" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/Oauth2ClientInsert_ApplicationConfig" }, { "$ref" : "#/components/schemas/Saml2ClientInsert_ApplicationConfig" } ] }, "GenericClientResponse_ApplicationConfig" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/SspClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/OrgPortalClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/OAuth2ClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/Saml2ClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/BridgeClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/OAuth2NativeClientResponse_ApplicationConfig" } ] }, "GenericClientUpdateRequest_ApplicationConfig" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/SspClientUpdate_ApplicationConfig" }, { "$ref" : "#/components/schemas/OrgPortalClientUpdate_ApplicationConfig" }, { "$ref" : "#/components/schemas/Oauth2ClientUpdate_ApplicationConfig" }, { "$ref" : "#/components/schemas/Saml2ClientUpdate_ApplicationConfig" }, { "$ref" : "#/components/schemas/BridgeClientUpdate_ApplicationConfig" }, { "$ref" : "#/components/schemas/OAuth2NativeClientUpdate_ApplicationConfig" } ] }, "GenericClient_InsertRequest" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/Oauth2Client_InsertRequest" }, { "$ref" : "#/components/schemas/Saml2Client_InsertRequest" } ] }, "GenericEnterpriseLoginProviderRequest" : { "type" : "object", "description" : "Represents an enterprise login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/OidcLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/Saml2LoginProviderUpsertRequest" } ] }, "GenericEnterpriseLoginProviderResponse" : { "type" : "object", "description" : "Represents an enterprise login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderResponse" }, { "$ref" : "#/components/schemas/OidcLoginProviderResponse" }, { "$ref" : "#/components/schemas/Saml2LoginProviderResponse" } ] }, "GenericSocialLoginProviderRequest" : { "type" : "object", "description" : "Represents a social login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/AppleLoginProviderUpsertRequest" }, { "$ref" : "#/components/schemas/SocialLoginProviderUpsertRequest" } ] }, "GenericSocialLoginProviderResponse" : { "type" : "object", "description" : "Represents a social login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/AppleLoginProviderResponse" }, { "$ref" : "#/components/schemas/SocialLoginProviderResponse" } ] }, "GenericTranslationResponse" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/LanguageCodeListResponse" }, { "$ref" : "#/components/schemas/TranslationListResponse" } ] }, "Generic_EnterpriseLoginProvider_InsertRequest" : { "type" : "object", "description" : "Represents an enterprise login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/Oidc_Specialized_LoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/Oidc_LoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/Saml2_LoginProvider_InsertRequest" } ] }, "Generic_SocialLoginProvider_InsertRequest" : { "type" : "object", "description" : "Represents a social login provider.", "oneOf" : [ { "$ref" : "#/components/schemas/Apple_LoginProvider_InsertRequest" }, { "$ref" : "#/components/schemas/SocialLoginProvider_InsertRequest" } ] }, "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" }, "GroupApiSecurityPolicyAssignmentRequest" : { "required" : [ "apiAccessPolicy", "scopes" ], "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "scopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OnlyIdRequest" } } }, "description" : "Represents a group API security policy assignment to be inserted or updated" }, "GroupApiSecurityPolicyAssignmentResponse" : { "type" : "object", "properties" : { "apiAccessPolicy" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "scopes" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NameAndIdResponse" } } }, "description" : "Represents a group API security policy assignment" }, "GroupInsertRequest" : { "required" : [ "name" ], "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" } } }, "GroupMemberInsertRequest_Account" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented account" } } }, "GroupResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "GroupUpdateRequest" : { "required" : [ "id", "name" ], "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" } } }, "HookInfoResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string" } } }, "HookOverrideUpsertRequest" : { "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity (nullable)" }, "variableOverrides" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest" }, { "$ref" : "#/components/schemas/NoValueRequest" }, { "$ref" : "#/components/schemas/StaticSecretRequest" }, { "$ref" : "#/components/schemas/StaticVariableRequest" }, { "$ref" : "#/components/schemas/VariableReferenceRequest" } ] } } }, "description" : "Defines lifecycle event hook overrides for the variant.\nAlternative hook configuration for a specific hook type: `\"HOOK_TYPE\" : {\"id\" : \"\"}`\nRemove hook: `\"HOOK_TYPE\" : {\"id\" : null}`" }, "HookVariableResponse_EventHookFunction" : { "type" : "object", "properties" : { "default" : { "$ref" : "#/components/schemas/DefaultValueResponse_EventHookFunction" }, "description" : { "type" : "string" }, "name" : { "type" : "string" }, "required" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] } } }, "HookVariableUpsertRequest_EventHookFunction" : { "required" : [ "default", "name", "type" ], "type" : "object", "properties" : { "default" : { "oneOf" : [ { "$ref" : "#/components/schemas/DefaultValueRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/NoValueRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticSecretRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/StaticVariableRequest_EventHookFunction" }, { "$ref" : "#/components/schemas/VariableReferenceRequest_EventHookFunction" } ] }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 0, "pattern" : "^$|^[A-Za-z_][A-Za-z_0-9]*$", "type" : "string" }, "required" : { "type" : "boolean" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] } } }, "Http" : { "type" : "object", "properties" : { "request" : { "$ref" : "#/components/schemas/Request" }, "response" : { "$ref" : "#/components/schemas/Response" } }, "description" : "Represents the HTTP communication for an event" }, "HttpsConfiguration" : { "type" : "object", "properties" : { "headerName" : { "type" : "string" }, "url" : { "type" : "string" } } }, "HttpsEventStreamingInsertRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/HttpsEventStreamingInsertRequest.Configuration" } } } ] }, "HttpsEventStreamingInsertRequest.Configuration" : { "required" : [ "apiKey", "headerName", "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "headerName" : { "maxLength" : 64, "minLength" : 0, "type" : "string" }, "url" : { "type" : "string" } } }, "HttpsEventStreamingUpdateRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/HttpsEventStreamingUpdateRequest.Configuration" } } } ] }, "HttpsEventStreamingUpdateRequest.Configuration" : { "required" : [ "headerName", "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "headerName" : { "maxLength" : 64, "minLength" : 0, "type" : "string" }, "url" : { "type" : "string" } } }, "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_AccountAttribute" : { "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" } } }, "IdReferenceRequest_ApplicationConfig" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_Claim" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_IdentityProofing" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_IdentityStore" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceRequest_OrganizationPolicy" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceResponse_AccountInvitationDetails" : { "type" : "object", "properties" : { "id" : { "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" } } }, "IdReferenceResponse_ApplicationConfig" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "IdReferenceResponse_OrganizationPolicy" : { "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" } ] }, "IdentityProofingListResponse_IdentityProofing" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" } } }, "IdentityProofingResponse_IdentityProofing" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "failureMessage" : { "$ref" : "#/components/schemas/FailureMessageResponse_IdentityProofing" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "proofingNotification" : { "$ref" : "#/components/schemas/ProofingNotificationResponse_IdentityProofing" } } }, "IdentityProofingStepResponse" : { "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/Actions" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "discriminator" : { "propertyName" : "type" } }, "IdentityProofingTranslation" : { "type" : "object", "properties" : { "dataSteps" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IdentityProofingTranslationDataStep" } }, "failureMessage" : { "type" : "string" }, "proofingNotificationDisplayText" : { "type" : "string" } } }, "IdentityProofingTranslationDataStep" : { "type" : "object", "properties" : { "displayText" : { "type" : "string" }, "fields" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IdentityProofingTranslationField" } } } }, "IdentityProofingTranslationField" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" } } }, "IdentityProofingUpsertRequest_IdentityProofing" : { "required" : [ "failureMessage", "id", "name", "proofingNotification" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "failureMessage" : { "$ref" : "#/components/schemas/FailureMessage_IdentityProofing" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "proofingNotification" : { "$ref" : "#/components/schemas/ProofingNotification_IdentityProofing" } } }, "IdentityProofing_InsertRequest" : { "required" : [ "failureMessage", "name", "proofingNotification" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "failureMessage" : { "$ref" : "#/components/schemas/FailureMessage_IdentityProofing" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "proofingNotification" : { "$ref" : "#/components/schemas/ProofingNotification_IdentityProofing" } } }, "IdentityStoreListResponse" : { "type" : "object", "properties" : { "accountEventTTL" : { "type" : "integer", "format" : "int32" }, "description" : { "type" : "string" }, "name" : { "type" : "string", "example" : "Default" }, "organizationRegistrationEnabled" : { "type" : "boolean" }, "passwordPolicy" : { "$ref" : "#/components/schemas/NameAndId" }, "policyTag" : { "type" : "string" } } }, "IdentityStoreResponse" : { "type" : "object", "properties" : { "accountEventTTL" : { "type" : "integer", "format" : "int32" }, "connector" : { "$ref" : "#/components/schemas/IdentityStoreResponse_Connector" }, "description" : { "type" : "string" }, "eventHookFunctions" : { "uniqueItems" : true, "type" : "array", "description" : "Event hook functions assigned to the identity store", "items" : { "$ref" : "#/components/schemas/AssignedEventHookFunctionResponse" } }, "name" : { "type" : "string", "example" : "Default" }, "organizationRegistrationEnabled" : { "type" : "boolean" }, "passwordPolicy" : { "$ref" : "#/components/schemas/NameAndId" }, "policyTag" : { "type" : "string" } } }, "IdentityStoreResponse_Connector" : { "type" : "object", "properties" : { "cachePassword" : { "type" : "boolean" }, "credentials" : { "$ref" : "#/components/schemas/Credentials" }, "enabled" : { "type" : "boolean" }, "syncPasswordToRemote" : { "type" : "boolean" } } }, "IdentityStoreResponse_Connector_IdentityStore" : { "type" : "object", "properties" : { "cachePassword" : { "type" : "boolean" }, "credentials" : { "$ref" : "#/components/schemas/Credentials_IdentityStore" }, "enabled" : { "type" : "boolean" }, "syncPasswordToRemote" : { "type" : "boolean" } } }, "IdentityStoreResponse_IdentityStore" : { "type" : "object", "properties" : { "accountEventTTL" : { "type" : "integer", "format" : "int32" }, "connector" : { "$ref" : "#/components/schemas/IdentityStoreResponse_Connector_IdentityStore" }, "description" : { "type" : "string" }, "eventHookFunctions" : { "uniqueItems" : true, "type" : "array", "description" : "Event hook functions assigned to the identity store", "items" : { "$ref" : "#/components/schemas/AssignedEventHookFunctionResponse_IdentityStore" } }, "name" : { "type" : "string", "example" : "Default" }, "organizationRegistrationEnabled" : { "type" : "boolean" }, "passwordPolicy" : { "$ref" : "#/components/schemas/NameAndId_IdentityStore" }, "policyTag" : { "type" : "string" } } }, "IdentityStoreUpsertRequest_Connector_IdentityStore" : { "type" : "object", "properties" : { "cachePassword" : { "type" : "boolean", "default" : true }, "enabled" : { "type" : "boolean", "default" : false }, "syncPasswordToRemote" : { "type" : "boolean", "default" : false } } }, "IdentityStoreUpsertRequest_IdentityStore" : { "required" : [ "eventHookFunctions", "name", "passwordPolicy" ], "type" : "object", "properties" : { "accountEventTTL" : { "type" : "integer", "description" : "An account event TTL in days how long account events will be stored in a given identity store. Check /admin/api/v1/accountEventTTLs endpoint for valid values for your deployment. 0 means the account event will be stored permanently.", "format" : "int32", "default" : 30, "enum" : [ 0, 30, 60, 90, 180, 365 ] }, "attributeCreationStrategy" : { "type" : "string", "default" : "defaultAttributes", "enum" : [ "emptyAttributes", "defaultAttributes" ] }, "connector" : { "$ref" : "#/components/schemas/IdentityStoreUpsertRequest_Connector_IdentityStore" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "eventHookFunctions" : { "type" : "array", "description" : "Event hook functions to be assigned to the identity store", "items" : { "$ref" : "#/components/schemas/EventHookAssignmentUpsertRequest_IdentityStore" }, "default" : [ ] }, "name" : { "maxLength" : 32, "minLength" : 2, "pattern" : "[a-zA-Z]+", "type" : "string", "example" : "StoreName" }, "organizationRegistrationEnabled" : { "type" : "boolean" }, "passwordPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_IdentityStore" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "IdentityVerificationAddressRiskEvaluationStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents an address risk evaluation identity verification step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskEvaluationStepConfiguration" } } } ] }, "IdentityVerificationAddressRiskEvaluationStepConfiguration" : { "required" : [ "claimManagement", "ruleManagement" ], "type" : "object", "properties" : { "claimManagement" : { "$ref" : "#/components/schemas/ClaimManagement" }, "ruleManagement" : { "$ref" : "#/components/schemas/RuleManagement" } }, "description" : "Represents the configuration of a address risk evaluation step configuration" }, "IdentityVerificationAddressRiskVerificationAttribute" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } }, "description" : "Represents an address risk verification attribute for address risk verification step" }, "IdentityVerificationDataStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents an identity verification data step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationDataStepConfiguration" } } } ] }, "IdentityVerificationDataStepConfiguration" : { "required" : [ "fields", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "displayText" : { "maxLength" : 2048, "minLength" : 0, "pattern" : "^((?![<>]).)*$", "type" : "string" }, "fields" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityVerificationDataStepField" }, "default" : [ ] }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" } }, "description" : "Represents the configuration of an identity verification data step" }, "IdentityVerificationDataStepField" : { "required" : [ "displayName", "id" ], "type" : "object", "properties" : { "displayName" : { "maxLength" : 64, "minLength" : 0, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "nativeClaim", "compoundAddress" ] } }, "description" : "Represents a field of an identity verification data step", "discriminator" : { "propertyName" : "type" }, "oneOf" : [ { "$ref" : "#/components/schemas/ProofingDataStepCompoundAddressField" }, { "$ref" : "#/components/schemas/ProofingDataStepNativeClaimField" } ] }, "IdentityVerificationDataStepNativeClaimConfiguration" : { "required" : [ "displayOption", "nativeClaim" ], "type" : "object", "properties" : { "displayOption" : { "type" : "string", "enum" : [ "readOnly", "readOnlyMasked", "readWrite" ] }, "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "required" : { "type" : "boolean", "default" : true } } }, "IdentityVerificationDocumentBasedStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a document based identity verification step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentBasedStepConfiguration" } } } ] }, "IdentityVerificationDocumentBasedStepConfiguration" : { "required" : [ "address", "document", "personal" ], "type" : "object", "properties" : { "address" : { "$ref" : "#/components/schemas/DocumentVerificationAddress" }, "document" : { "$ref" : "#/components/schemas/DocumentVerificationDocument" }, "personal" : { "$ref" : "#/components/schemas/DocumentVerificationPersonal" } }, "description" : "Represents the configuration of a document based identity verification step" }, "IdentityVerificationDocumentVerificationAttribute" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } }, "description" : "Represents a document verification attribute for document verification step" }, "IdentityVerificationKnowledgeBasedStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a knowledge based identity verification step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedStepConfiguration" } } } ] }, "IdentityVerificationKnowledgeBasedStepConfiguration" : { "required" : [ "city", "countryCode", "dateOfBirth", "familyName", "givenName", "phoneNumber", "postalCode", "state", "streetAddress" ], "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "countryCode" : { "$ref" : "#/components/schemas/IdentityVerificationNullableKnowledgeBasedVerificationStepAttribute" }, "dateOfBirth" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "familyName" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "givenName" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "phoneNumber" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "postalCode" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "state" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" }, "streetAddress" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedVerificationStepAttribute" } } }, "IdentityVerificationKnowledgeBasedVerificationStepAttribute" : { "required" : [ "nativeClaim" ], "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } } }, "IdentityVerificationNullableKnowledgeBasedVerificationStepAttribute" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } } }, "IdentityVerificationPhoneBasedStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a phone based identity verification step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepConfiguration" } } } ] }, "IdentityVerificationPhoneBasedStepConfiguration" : { "required" : [ "dataSources", "phoneNumber" ], "type" : "object", "properties" : { "dataSources" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepConfigurationDataSource" }, "failureCountThreshold" : { "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 1 }, "phoneNumber" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepPhoneNumberAffirmationAttribute" } }, "description" : "Represents the configuration of a phone based identity verification step" }, "IdentityVerificationPhoneBasedStepConfigurationDataSource" : { "required" : [ "city", "countryCode", "dateOfBirth", "familyName", "givenName", "nationalId", "postalCode", "state", "streetAddress" ], "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "countryCode" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "dateOfBirth" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "familyName" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "givenName" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "nationalId" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "postalCode" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "state" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" }, "streetAddress" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" } }, "description" : "Represents the data source of a phone based identity verification step" }, "IdentityVerificationPhoneBasedStepIdentityAffirmationAttribute" : { "required" : [ "failureCriteria", "thresholdAction" ], "type" : "object", "properties" : { "failureCriteria" : { "type" : "string", "enum" : [ "exactMatch", "highPartialMatch", "partialMatch" ] }, "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "thresholdAction" : { "type" : "string", "enum" : [ "none", "mandatoryToPass", "failureCount" ] } }, "description" : "Represents an identity affirmation attribute for phone based identity verification step" }, "IdentityVerificationPhoneBasedStepPhoneNumberAffirmationAttribute" : { "required" : [ "nativeClaim" ], "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } }, "description" : "Represents a phone number affirmation attribute for phone based identity verification step" }, "IdentityVerificationPhoneNumberRiskStep" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents phone number risk based identity verification step", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationStep" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneNumberRiskStepConfiguration" } } } ] }, "IdentityVerificationPhoneNumberRiskStepAttribute" : { "required" : [ "nativeClaim" ], "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/OnlyIdRequest" } }, "description" : "Represents an attribute for phone number risk based identity verification step" }, "IdentityVerificationPhoneNumberRiskStepConfiguration" : { "required" : [ "forbiddenPhoneTypes", "phoneNumber" ], "type" : "object", "properties" : { "forbiddenPhoneTypes" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneNumberRiskStepForbiddenPhoneTypes" }, "numberPortingRisk" : { "type" : "boolean" }, "phoneNumber" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneNumberRiskStepAttribute" } }, "description" : "Represents the configuration of a phone number risk based identity verification step" }, "IdentityVerificationPhoneNumberRiskStepForbiddenPhoneTypes" : { "type" : "object", "properties" : { "fixedVoip" : { "type" : "boolean" }, "landLine" : { "type" : "boolean" }, "mobile" : { "type" : "boolean" }, "nonFixedVoip" : { "type" : "boolean" }, "other" : { "type" : "boolean" } }, "description" : "Represents forbidden phone types for a phone number risk based identity verification step" }, "IdentityVerificationStep" : { "required" : [ "actions", "id", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, "IdentityVerificationStepAction" : { "required" : [ "failure", "success" ], "type" : "object", "properties" : { "failure" : { "type" : "string", "enum" : [ "nextStep", "failureMessage", "exitProofing" ] }, "success" : { "type" : "string", "enum" : [ "nextStep", "exitProofing" ] } }, "description" : "Actions for step result" }, "IdentityVerificationStep_InsertRequest" : { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, "IdentityVerification_AddressRiskEvaluationStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents an address risk evaluation identity verification step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationAddressRiskEvaluationStepConfiguration" } } } ] }, "IdentityVerification_DataStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents an identity verification data step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationDataStepConfiguration" } } } ] }, "IdentityVerification_DocumentBasedStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a document based identity verification step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationDocumentBasedStepConfiguration" } } } ] }, "IdentityVerification_KnowledgeBasedStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a knowledge based identity verification step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationKnowledgeBasedStepConfiguration" } } } ] }, "IdentityVerification_PhoneBasedStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents a phone based identity verification step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneBasedStepConfiguration" } } } ] }, "IdentityVerification_PhoneNumberRiskStep_InsertRequest" : { "required" : [ "actions", "configuration", "id", "type" ], "type" : "object", "description" : "Represents phone number risk based identity verification step", "allOf" : [ { "required" : [ "actions", "type" ], "type" : "object", "properties" : { "actions" : { "$ref" : "#/components/schemas/IdentityVerificationStepAction" }, "enabled" : { "type" : "boolean", "default" : false }, "type" : { "type" : "string", "enum" : [ "addressRiskEvaluation", "documentVerification", "knowledgeBasedVerification", "phoneNumberRiskEvaluation", "phoneBasedIdentityAffirmation", "proofingData" ] } }, "description" : "Represents an identity verification step", "discriminator" : { "propertyName" : "type" } }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationPhoneNumberRiskStepConfiguration" } } } ] }, "ImpersonationInsertRequest_Account" : { "required" : [ "clientId", "reason" ], "type" : "object", "properties" : { "clientId" : { "type" : "string" }, "reason" : { "maxLength" : 512, "minLength" : 0, "type" : "string" } } }, "ImpersonationResponse_Account" : { "type" : "object", "properties" : { "impersonationUrl" : { "type" : "string" } } }, "InfobipCreateRequestConfiguration" : { "required" : [ "apiKey", "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "sender" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "InfobipInsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/InfobipCreateRequestConfiguration" } } } ] }, "InfobipUpdateRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/InfobipUpdateRequestConfiguration" } } } ] }, "InfobipUpdateRequestConfiguration" : { "required" : [ "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string", "description" : "Setting apiKey to null retains its previous value instead of updating to null." }, "sender" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "InstanceAddress_InstanceConfig" : { "type" : "object", "properties" : { "additional" : { "type" : "array", "items" : { "type" : "string" } }, "default" : { "type" : "string" } }, "description" : "Represents an instance address" }, "InstanceConfigResponse_InstanceConfig" : { "type" : "object", "properties" : { "companyName" : { "type" : "string" }, "hostingRegion" : { "type" : "string" }, "instanceAddress" : { "$ref" : "#/components/schemas/InstanceAddress_InstanceConfig" }, "ipAllowedList" : { "type" : "array", "items" : { "type" : "string" } }, "releaseVersion" : { "type" : "string" } } }, "InstanceConfigUpdateRequest_InstanceConfig" : { "required" : [ "companyName" ], "type" : "object", "properties" : { "companyName" : { "maxLength" : 48, "minLength" : 2, "pattern" : "^[- a-zA-Z0-9@£$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ!\"#¤%&'()*+,.\\/:;<=>?¡ÄÖÑܧ¿äöñüà]*$", "type" : "string" }, "ipAllowedList" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "description" : "This represents a list of subnet ranges (CIDR). See: [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632). Private addresses are not allowed.", "items" : { "type" : "string", "example" : "1.1.1.1/32" } } } }, "InstanceConfig_InsertRequest" : { "required" : [ "companyName" ], "type" : "object", "properties" : { "companyName" : { "maxLength" : 48, "minLength" : 2, "pattern" : "^[- a-zA-Z0-9@£$¥èéùìòÇØøÅåΔ_ΦΓΛΩΠΨΣΘΞÆæßÉ!\"#¤%&'()*+,.\\/:;<=>?¡ÄÖÑܧ¿äöñüà]*$", "type" : "string" }, "ipAllowedList" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "description" : "This represents a list of subnet ranges (CIDR). See: [RFC 4632](https://www.rfc-editor.org/rfc/rfc4632). Private addresses are not allowed.", "items" : { "type" : "string", "example" : "1.1.1.1/32" } } } }, "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" }, "JobIdReferenceResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "Journey" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "name" : { "type" : "string" } } }, "JourneyIntegrationListResponse" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "maintainer" : { "type" : "string" }, "summary" : { "type" : "string" } } }, "JourneyIntegrationResponse" : { "type" : "object", "properties" : { "categories" : { "type" : "array", "items" : { "type" : "string" } }, "description" : { "type" : "string" }, "displayName" : { "type" : "string" }, "journeys" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/Journey" } }, "logoUrl" : { "type" : "string" }, "maintainer" : { "type" : "string" }, "summary" : { "type" : "string" } } }, "JwksRequest_ApplicationConfig" : { "required" : [ "keys" ], "type" : "object", "properties" : { "keys" : { "maxItems" : 32, "minItems" : 1, "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } }, "JwksResponse_ApplicationConfig" : { "type" : "object", "properties" : { "keys" : { "type" : "array", "items" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } } }, "KnowledgeBasedVerificationAttributeResponse" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } }, "KnowledgeBasedVerificationStepConfigurationResponse" : { "type" : "object", "properties" : { "city" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "countryCode" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "dateOfBirth" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "familyName" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "givenName" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "phoneNumber" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "postalCode" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "state" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" }, "streetAddress" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationAttributeResponse" } } }, "KnowledgeBasedVerificationStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/KnowledgeBasedVerificationStepConfigurationResponse" } } } ] }, "LanguageCodeListResponse" : { "type" : "object", "properties" : { "languageCode" : { "type" : "string" } } }, "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" }, "LifecycleAction" : { "type" : "object", "properties" : { "action" : { "type" : "string", "enum" : [ "deleteAccount", "disableAccount", "assignGroup", "removeGroup", "assignOrganizationRole", "deleteOrganizationRole" ] } }, "discriminator" : { "propertyName" : "action" } }, "LifecycleActionRequest" : { "required" : [ "action" ], "type" : "object", "properties" : { "action" : { "type" : "string", "enum" : [ "deleteAccount", "disableAccount", "assignGroup", "removeGroup", "assignOrganizationRole", "deleteOrganizationRole" ] } }, "discriminator" : { "propertyName" : "action" } }, "LifecycleActionWithGroupTarget" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/LifecycleAction" }, { "type" : "object", "properties" : { "group" : { "type" : "string" } } } ] }, "LifecycleActionWithGroupTargetRequest" : { "required" : [ "action", "group" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/LifecycleActionRequest" }, { "type" : "object", "properties" : { "group" : { "type" : "string" } } } ] }, "LifecycleActionWithRoleTarget" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/LifecycleAction" }, { "type" : "object", "properties" : { "organization" : { "type" : "string" }, "role" : { "type" : "string" } } } ] }, "LifecycleActionWithRoleTargetRequest" : { "required" : [ "action", "organization", "role" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/LifecycleActionRequest" }, { "type" : "object", "properties" : { "organization" : { "type" : "string" }, "role" : { "type" : "string" } } } ] }, "LifecycleEventHook" : { "type" : "object", "properties" : { "code" : { "type" : "string" }, "name" : { "type" : "string" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string" } } } }, "LifecycleRuleInsertRequest" : { "required" : [ "actions", "filter", "name" ], "type" : "object", "properties" : { "actions" : { "maxItems" : 1, "minItems" : 0, "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/LifecycleActionRequest" }, { "$ref" : "#/components/schemas/LifecycleActionWithGroupTargetRequest" }, { "$ref" : "#/components/schemas/LifecycleActionWithRoleTargetRequest" } ] } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "filter" : { "$ref" : "#/components/schemas/FilterRequest" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" } } }, "LifecycleRuleListResponse" : { "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/LifecycleAction" }, { "$ref" : "#/components/schemas/LifecycleActionWithGroupTarget" }, { "$ref" : "#/components/schemas/LifecycleActionWithRoleTarget" } ] } }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "filter" : { "$ref" : "#/components/schemas/Filter" }, "id" : { "type" : "string" }, "lastExecution" : { "$ref" : "#/components/schemas/ExecutionStatus" }, "name" : { "type" : "string" } } }, "LifecycleRuleResponse" : { "type" : "object", "properties" : { "actions" : { "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/LifecycleAction" }, { "$ref" : "#/components/schemas/LifecycleActionWithGroupTarget" }, { "$ref" : "#/components/schemas/LifecycleActionWithRoleTarget" } ] } }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "filter" : { "$ref" : "#/components/schemas/Filter" }, "id" : { "type" : "string" }, "lastExecution" : { "$ref" : "#/components/schemas/ExecutionStatus" }, "name" : { "type" : "string" } } }, "LifecycleRuleUpdateRequest" : { "required" : [ "actions", "filter", "id", "name" ], "type" : "object", "properties" : { "actions" : { "maxItems" : 1, "minItems" : 0, "type" : "array", "items" : { "oneOf" : [ { "$ref" : "#/components/schemas/LifecycleActionRequest" }, { "$ref" : "#/components/schemas/LifecycleActionWithGroupTargetRequest" }, { "$ref" : "#/components/schemas/LifecycleActionWithRoleTargetRequest" } ] } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "filter" : { "$ref" : "#/components/schemas/FilterRequest" }, "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" } } }, "Link_Stats" : { "type" : "object", "properties" : { "href" : { "type" : "string" }, "meta" : { "type" : "object", "additionalProperties" : { "type" : "string" } } }, "description" : "Represents a single link for statistics" }, "LinksResponse_Stats" : { "type" : "object", "properties" : { "self" : { "$ref" : "#/components/schemas/Link_Stats" } } }, "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" }, "LogListResponse" : { "type" : "object", "properties" : { "level" : { "type" : "string" }, "message" : { "type" : "string" }, "timestamp" : { "type" : "string" } } }, "LogSummaryResponse" : { "type" : "object", "properties" : { "error" : { "type" : "integer", "format" : "int32" }, "exception" : { "type" : "boolean" }, "info" : { "type" : "integer", "format" : "int32" } } }, "LoginProvidersRequest_ApplicationConfig" : { "required" : [ "enterpriseLoginProviders", "socialLoginProviders" ], "type" : "object", "properties" : { "enterpriseLoginProviders" : { "type" : "array", "description" : "Enterprise login providers to be assigned to the application", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "default" : [ ] }, "forwardToExternalProviderEnabled" : { "type" : "boolean", "default" : false }, "localLoginProviderEnabled" : { "type" : "boolean", "default" : true }, "socialLoginProviders" : { "type" : "array", "description" : "Social login providers to be assigned to the application", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "default" : [ ] } }, "description" : "Login provider assignments for an application" }, "LoginProvidersResponse_ApplicationConfig" : { "type" : "object", "properties" : { "enterpriseLoginProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" } }, "forwardToExternalProviderEnabled" : { "type" : "boolean" }, "localLoginProviderEnabled" : { "type" : "boolean" }, "socialLoginProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" } } }, "description" : "Login provider assignments for an application" }, "LoginProviders_OrganizationPolicy" : { "required" : [ "enterpriseLoginProviders", "socialLoginProviders" ], "type" : "object", "properties" : { "enterpriseLoginProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" } }, "forwardToExternalProviderEnabled" : { "type" : "boolean", "default" : false }, "localLoginProviderEnabled" : { "type" : "boolean", "default" : false }, "socialLoginProviders" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" } } }, "description" : "Represents both social and enterprise login providers." }, "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" } } }, "ModifiableClientResponse_ApplicationConfig" : { "type" : "object", "oneOf" : [ { "$ref" : "#/components/schemas/OrgPortalClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/OAuth2ClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/Saml2ClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/BridgeClientResponse_ApplicationConfig" }, { "$ref" : "#/components/schemas/OAuth2NativeClientResponse_ApplicationConfig" } ] }, "NameAndId" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameAndIdResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" }, "name" : { "type" : "string", "description" : "Name of the represented entity", "example" : "Entity name" } } }, "NameAndIdResponse_ApplicationConfig" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameAndIdResponse_IdentityProofing" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameAndId_ApiAccessPolicy" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameAndId_ApplicationConfig" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" }, "name" : { "type" : "string", "description" : "Name of the represented entity", "example" : "Entity name" } } }, "NameAndId_IdentityStore" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the represented entity" } } }, "NameAndId_OrganizationPolicy" : { "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" } } }, "NameIdAndDisplayName_Claim" : { "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" } } }, "NameReferenceRequest_ApplicationConfig" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the represented entity", "example" : "Entity name" } } }, "NameReferenceResponse_ApplicationConfig" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the represented entity", "example" : "Entity name" } } }, "NativeClaimResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "dialectUri" : { "type" : "string" }, "displayName" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "readonly" : { "type" : "boolean" } } }, "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" } } }, "NativeClaim_InsertRequest" : { "required" : [ "displayName", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "dialectUri" : { "type" : "string", "default" : "http://strivacity.com/claims" }, "displayName" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z][a-zA-Z0-9_!#$&'()*+,\\/:;=?@\\[\\].]*$", "type" : "string" }, "readonly" : { "type" : "boolean", "readOnly" : true } } }, "NativeClaim_NativeClaim" : { "required" : [ "displayName", "id", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "dialectUri" : { "type" : "string", "default" : "http://strivacity.com/claims" }, "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" }, "readonly" : { "type" : "boolean", "readOnly" : true } } }, "NoValueRequest" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest" } ] }, "NoValueRequest_ApplicationConfig" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_ApplicationConfig" } ] }, "NoValueRequest_EventHookFunction" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DefaultValueRequest_EventHookFunction" } ] }, "NoValueRequest_IdentityStore" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_IdentityStore" } ] }, "NoValueResponse_EventHookFunction" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } } }, "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." }, "NotificationPolicyResponse_NotificationPolicy" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "sender" : { "type" : "string" } } }, "NotificationPolicyUpsertRequest_NotificationPolicy" : { "required" : [ "id", "name", "sender" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "sender" : { "maxLength" : 64, "minLength" : 0, "pattern" : "([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\")(\\.([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\"))*", "type" : "string" } } }, "NotificationPolicy_InsertRequest" : { "required" : [ "name", "sender" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "sender" : { "maxLength" : 64, "minLength" : 0, "pattern" : "([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\")(\\.([a-z0-9!#$%&'*+/=?^_`{|}~€-￿-]+|\"([a-z0-9!#$%&'*.(),<>\\[\\]:; @+/=?^_`{|}~€-￿-]|\\\\\\\\|\\\\\")+\"))*", "type" : "string" } } }, "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" ] } } }, "NotificationTemplateTranslation" : { "type" : "object", "properties" : { "body" : { "type" : "string" }, "plainTextBody" : { "type" : "string" }, "subject" : { "type" : "string" } } }, "NpmPackageRequest_Npm" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the NPM dependency" } }, "description" : "Represents a package by its name for fetching available package versions" }, "NpmPackageSuggestion_Npm" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "name" : { "type" : "string" }, "version" : { "type" : "string", "example" : "1.0.0" } }, "description" : "Represents an NPM package suggestion based on a prefix search" }, "NpmPackageSuggestionsRequest_Npm" : { "required" : [ "query" ], "type" : "object", "properties" : { "query" : { "type" : "string", "description" : "Query string to match for NPM dependencies" } }, "description" : "Represents a query to match for NPM dependencies" }, "NpmPackage_Npm" : { "type" : "object", "properties" : { "packument" : { "$ref" : "#/components/schemas/Packument_Npm" } }, "description" : "Represents an NPM package" }, "NullableIdReferenceRequest" : { "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity (nullable)" } } }, "OAuth2ClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientOAuth2ConfigurationResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "OAuth2Configuration_ApplicationConfig" : { "required" : [ "dialect", "jwtSigningMethod", "tokenEndpointAuthMethod" ], "type" : "object", "properties" : { "accessTokenFormat" : { "type" : "string", "default" : "opaque", "enum" : [ "opaque", "jwt" ] }, "accessTokenLifespanMinutes" : { "maximum" : 1440, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 60 }, "backChannelLogoutUrl" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 1, "type" : "string" }, "default" : [ ] }, "callbackUrl" : { "$ref" : "#/components/schemas/CallbackURLRequest_ApplicationConfig" }, "customAudiences" : { "maxItems" : 32, "minItems" : 0, "type" : "array", "items" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "default" : [ ] }, "dialect" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "enableSelfServiceApiAccess" : { "type" : "boolean", "default" : false }, "idTokenLifespanMinutes" : { "maximum" : 1440, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 60 }, "interactiveLoginEnabled" : { "type" : "boolean", "default" : true }, "jwks" : { "$ref" : "#/components/schemas/JwksRequest_ApplicationConfig" }, "jwksAlgorithm" : { "type" : "string", "enum" : [ "RS256", "ES256" ] }, "jwksUri" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "jwtSigningMethod" : { "type" : "string", "enum" : [ "RS256" ] }, "logoutUrl" : { "$ref" : "#/components/schemas/CallbackURLRequest_ApplicationConfig" }, "refreshTokenGrantEnabled" : { "type" : "boolean", "default" : false }, "refreshTokenLifespanMinutes" : { "maximum" : 1576800, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 43200 }, "tokenEndpointAuthMethod" : { "type" : "string", "enum" : [ "client_secret_basic", "client_secret_post", "private_key_jwt", "none" ] } } }, "OAuth2NativeClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientOAuth2NativeConfigurationResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "OAuth2NativeClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientOAuth2NativeConfigurationUpdateRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "Oauth2ClientInsert_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/OAuth2Configuration_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "Oauth2ClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/OAuth2Configuration_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "Oauth2Client_InsertRequest" : { "required" : [ "applicationLauncherEntry", "configuration", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/OAuth2Configuration_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "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" } } }, "OidcLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcConfiguration" }, "description" : { "type" : "string" }, "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" } } }, "OidcLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "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 } } }, "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" } } }, "OidcSpecializedLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedConfiguration" }, "description" : { "type" : "string" }, "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" } } }, "OidcSpecializedLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "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 } } }, "Oidc_LoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "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 } } }, "Oidc_Specialized_LoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OidcSpecializedLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "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 } } }, "OnlyIdRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" } } }, "OnlyIdRequest_IdentityProofing" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" } } }, "OnlyIdResponse" : { "type" : "object", "properties" : { "id" : { "type" : "string" } } }, "OrgPortalClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "OrgPortalClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "OrganizationConfigurationBrandRequest" : { "type" : "object", "properties" : { "backgroundColor" : { "type" : "string" }, "faviconUrl" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "primaryColor" : { "type" : "string" } } }, "OrganizationConfigurationBrandResponse" : { "type" : "object", "properties" : { "backgroundColor" : { "type" : "string" }, "faviconUrl" : { "type" : "string" }, "logoUrl" : { "type" : "string" }, "primaryColor" : { "type" : "string" } } }, "OrganizationConfigurationRequest" : { "type" : "object", "properties" : { "brand" : { "$ref" : "#/components/schemas/OrganizationConfigurationBrandRequest" }, "organizationRegistrationEnabled" : { "type" : "boolean", "default" : false }, "selfRegistrationEnabled" : { "type" : "boolean", "default" : false }, "uniqueIdentifier" : { "type" : "boolean", "default" : false } }, "description" : "Represents an organization configuration" }, "OrganizationConfigurationResponse" : { "type" : "object", "properties" : { "brand" : { "$ref" : "#/components/schemas/OrganizationConfigurationBrandResponse" }, "organizationRegistrationEnabled" : { "type" : "boolean" }, "selfRegistrationEnabled" : { "type" : "boolean" }, "uniqueIdentifier" : { "type" : "boolean" }, "uniqueIdentifierRoot" : { "type" : "string" } } }, "OrganizationPolicyResponseLoginProviders_OrganizationPolicy" : { "type" : "object", "properties" : { "enterpriseLoginProviders" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_OrganizationPolicy" } }, "forwardToExternalProviderEnabled" : { "type" : "boolean" }, "localLoginProviderEnabled" : { "type" : "boolean" }, "socialLoginProviders" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/IdReferenceResponse_OrganizationPolicy" } } } }, "OrganizationPolicyResponsePolicies_OrganizationPolicy" : { "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/NameAndId_OrganizationPolicy" }, "brand" : { "$ref" : "#/components/schemas/NameAndId_OrganizationPolicy" }, "identityProofing" : { "$ref" : "#/components/schemas/NameAndId_OrganizationPolicy" }, "notificationPolicy" : { "$ref" : "#/components/schemas/NameAndId_OrganizationPolicy" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/NameAndId_OrganizationPolicy" } } }, "OrganizationPolicyResponse_OrganizationPolicy" : { "type" : "object", "properties" : { "loginProviders" : { "$ref" : "#/components/schemas/OrganizationPolicyResponseLoginProviders_OrganizationPolicy" }, "organization" : { "$ref" : "#/components/schemas/OrganizationResponse_OrganizationPolicy" }, "policies" : { "$ref" : "#/components/schemas/OrganizationPolicyResponsePolicies_OrganizationPolicy" } } }, "OrganizationPolicyUpsertRequest_OrganizationPolicy" : { "required" : [ "organization" ], "type" : "object", "properties" : { "loginProviders" : { "$ref" : "#/components/schemas/LoginProviders_OrganizationPolicy" }, "organization" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" }, "policies" : { "$ref" : "#/components/schemas/Policies_OrganizationPolicy" } } }, "OrganizationResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OrganizationConfigurationResponse" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "parent" : { "$ref" : "#/components/schemas/NameAndIdResponse" }, "routes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "OrganizationResponse_OrganizationPolicy" : { "type" : "object", "properties" : { "id" : { "type" : "string" } } }, "OrganizationUpsertRequest" : { "required" : [ "id", "name", "routes" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OrganizationConfigurationRequest" }, "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" }, "parent" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "routes" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "items" : { "maxLength" : 63, "minLength" : 1, "pattern" : "^|[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "type" : "string" } } } }, "Organization_InsertRequest" : { "required" : [ "name", "routes" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/OrganizationConfigurationRequest" }, "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" }, "parent" : { "$ref" : "#/components/schemas/OnlyIdRequest" }, "routes" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "items" : { "maxLength" : 63, "minLength" : 1, "pattern" : "^|[a-z0-9]([-a-z0-9]*[a-z0-9])?$", "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." }, "Packument_Npm" : { "type" : "object", "properties" : { "version" : { "type" : "string", "description" : "Latest stable version of the NPM package", "example" : "1.0.0" }, "versions" : { "type" : "array", "description" : "Available versions of the NPM package", "items" : { "$ref" : "#/components/schemas/AvailableVersion_Npm" } } }, "description" : "Represents the available versions and the latest stable version for an NPM package" }, "PageAdaptiveAccessPolicyResponse_AdaptiveMFA" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AdaptiveAccessPolicyResponse_AdaptiveMFA" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_AdaptiveMFA" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageApiSecurityPolicyListResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApiSecurityPolicyListResponse_ApiAccessPolicy" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_ApiAccessPolicy" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageApplicationConfigListResponse_ApplicationConfig" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ApplicationConfigListResponse_ApplicationConfig" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_ApplicationConfig" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageAuditEntry" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/AuditEntry" } }, "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" } } }, "PageBrand_Brand" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Brand_Brand" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_Brand" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageClaimResponse_Claim" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ClaimResponse_Claim" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_Claim" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageConsent_Consent" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Consent_Consent" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_Consent" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageDialectResponse_Dialect" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DialectResponse_Dialect" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_Dialect" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageEventHookFunctionListItemResponse_EventHookFunction" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventHookFunctionListItemResponse_EventHookFunction" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_EventHookFunction" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageEventStreamingResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/EventStreamingResponse" } }, "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" } } }, "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" } } }, "PageExternalLoginProviderResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/ExternalLoginProviderResponse" } }, "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" } } }, "PageGroupResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GroupResponse" } }, "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" } } }, "PageIdentityProofingListResponse_IdentityProofing" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityProofingListResponse_IdentityProofing" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_IdentityProofing" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageIdentityStoreListResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/IdentityStoreListResponse" } }, "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" } } }, "PageNativeClaimResponse_NativeClaim" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NativeClaimResponse_NativeClaim" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_NativeClaim" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageNotificationPolicyResponse_NotificationPolicy" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/NotificationPolicyResponse_NotificationPolicy" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_NotificationPolicy" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageOfEnterpriseLoginProviderResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/GenericEnterpriseLoginProviderResponse" } }, "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" } } }, "PageOrganizationPolicyResponse_OrganizationPolicy" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/OrganizationPolicyResponse_OrganizationPolicy" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_OrganizationPolicy" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PagePasswordPolicyResponse_PasswordPolicy" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/PasswordPolicyResponse_PasswordPolicy" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_PasswordPolicy" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageRoleResponse_Role" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RoleResponse_Role" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_Role" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageSelfServicePolicyResponse_SelfServicePolicy" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SelfServicePolicyResponse_SelfServicePolicy" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_SelfServicePolicy" }, "size" : { "type" : "integer", "format" : "int32" }, "sort" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/SortObject" } }, "totalElements" : { "type" : "integer", "format" : "int64" }, "totalPages" : { "type" : "integer", "format" : "int32" } } }, "PageTelephonyProviderListResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/TelephonyProviderListResponse" } }, "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" } } }, "PageVariableListResponse" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/VariableListResponse" } }, "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" } } }, "PageWebAnalyticsResponse_WebAnalytics" : { "type" : "object", "properties" : { "content" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/WebAnalyticsResponse_WebAnalytics" } }, "empty" : { "type" : "boolean" }, "first" : { "type" : "boolean" }, "last" : { "type" : "boolean" }, "number" : { "type" : "integer", "format" : "int32" }, "numberOfElements" : { "type" : "integer", "format" : "int32" }, "pageable" : { "$ref" : "#/components/schemas/PageableObject_WebAnalytics" }, "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_AdaptiveMFA" : { "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_ApiAccessPolicy" : { "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_ApplicationConfig" : { "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_Brand" : { "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_Claim" : { "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_Consent" : { "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_Dialect" : { "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_EventHookFunction" : { "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_IdentityProofing" : { "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_NativeClaim" : { "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_NotificationPolicy" : { "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_OrganizationPolicy" : { "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_PasswordPolicy" : { "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_Role" : { "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_SelfServicePolicy" : { "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_WebAnalytics" : { "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" } ] }, "PasswordPolicyConstraints.EnforcePasswordChange_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Enables password `maxAgeDays` restriction", "default" : false }, "maxAgeDays" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "description" : "Enforce password change after a specified number of days", "format" : "int32", "default" : 30 } }, "description" : "Password age restriction configuration" }, "PasswordPolicyConstraints.FilterNumericCharacterSequences_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "maxAllowed" : { "maximum" : 5, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 2 } }, "description" : "Filter sequential numbers in passwords" }, "PasswordPolicyConstraints.FilterPreviousPasswords_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "description" : "Enables password `historySize` restriction", "default" : false }, "historySize" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "description" : "Specifies a restriction on the number of previous passwords that cannot be reused", "format" : "int32", "default" : 10 }, "minAgeDays" : { "maximum" : 99, "minimum" : 1, "type" : "integer", "description" : "Specifies a minimum time interval in days before a previously used password can be reused.", "format" : "int32", "default" : 3 }, "minAgeDaysEnabled" : { "type" : "boolean", "description" : "Enables password `minAgeDays` restriction", "default" : false } }, "description" : "Password reuse restriction configuration" }, "PasswordPolicyConstraints.FilterRepeatedCharacters_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : false }, "maxAllowed" : { "maximum" : 5, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 2 } }, "description" : "Filter repeated characters in passwords" }, "PasswordPolicyConstraintsResponse.EnforcePasswordChange_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "maxAgeDays" : { "type" : "integer", "format" : "int32" } }, "description" : "Enforce password change after certain days" }, "PasswordPolicyConstraintsResponse.FilterNumericCharacterSequences_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "maxAllowed" : { "type" : "integer", "format" : "int32" } }, "description" : "Filter sequential numbers in passwords" }, "PasswordPolicyConstraintsResponse.FilterPreviousPasswords_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "historySize" : { "type" : "integer", "format" : "int32" }, "minAgeDays" : { "type" : "integer", "format" : "int32" }, "minAgeDaysEnabled" : { "type" : "boolean" } }, "description" : "Disallow previously used passwords when changing password" }, "PasswordPolicyConstraintsResponse.FilterRepeatedCharacters_PasswordPolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "maxAllowed" : { "type" : "integer", "format" : "int32" } }, "description" : "Filter repeated characters in passwords" }, "PasswordPolicyConstraintsResponse_PasswordPolicy" : { "type" : "object", "properties" : { "enforcePasswordChange" : { "$ref" : "#/components/schemas/PasswordPolicyConstraintsResponse.EnforcePasswordChange_PasswordPolicy" }, "exclude" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "USERNAME_PART", "GIVEN_NAME", "FAMILY_NAME" ] } }, "filterNumericCharacterSequences" : { "$ref" : "#/components/schemas/PasswordPolicyConstraintsResponse.FilterNumericCharacterSequences_PasswordPolicy" }, "filterPreviousPasswords" : { "$ref" : "#/components/schemas/PasswordPolicyConstraintsResponse.FilterPreviousPasswords_PasswordPolicy" }, "filterRepeatedCharacters" : { "$ref" : "#/components/schemas/PasswordPolicyConstraintsResponse.FilterRepeatedCharacters_PasswordPolicy" }, "maximumLength" : { "type" : "integer", "format" : "int32" }, "minimumLength" : { "type" : "integer", "format" : "int32" }, "required" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "UPPERCASE", "LOWERCASE", "NUMERIC", "SPECIAL" ] } }, "restrictedCharacters" : { "type" : "string" } }, "description" : "Represents constraints the policy poses." }, "PasswordPolicyConstraints_PasswordPolicy" : { "required" : [ "enforcePasswordChange", "filterNumericCharacterSequences", "filterPreviousPasswords", "filterRepeatedCharacters" ], "type" : "object", "properties" : { "enforcePasswordChange" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints.EnforcePasswordChange_PasswordPolicy" }, "exclude" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "USERNAME_PART", "GIVEN_NAME", "FAMILY_NAME" ] }, "default" : [ ] }, "filterNumericCharacterSequences" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints.FilterNumericCharacterSequences_PasswordPolicy" }, "filterPreviousPasswords" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints.FilterPreviousPasswords_PasswordPolicy" }, "filterRepeatedCharacters" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints.FilterRepeatedCharacters_PasswordPolicy" }, "maximumLength" : { "maximum" : 256, "minimum" : 8, "type" : "integer", "format" : "int32", "default" : 256 }, "minimumLength" : { "maximum" : 64, "minimum" : 8, "type" : "integer", "format" : "int32", "default" : 8 }, "required" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "UPPERCASE", "LOWERCASE", "NUMERIC", "SPECIAL" ] }, "default" : [ ] }, "restrictedCharacters" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" } }, "description" : "Represents constraints the policy poses." }, "PasswordPolicyResponse_PasswordPolicy" : { "type" : "object", "properties" : { "breachedPasswordProtection" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "passwordRequirementIndicator" : { "type" : "boolean" }, "policy" : { "$ref" : "#/components/schemas/PasswordPolicyConstraintsResponse_PasswordPolicy" }, "policyTag" : { "type" : "string" } } }, "PasswordPolicyUpsertRequest_PasswordPolicy" : { "required" : [ "id", "name", "policy" ], "type" : "object", "properties" : { "breachedPasswordProtection" : { "type" : "boolean", "default" : true }, "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" }, "passwordRequirementIndicator" : { "type" : "boolean", "default" : true }, "policy" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints_PasswordPolicy" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "PasswordPolicy_InsertRequest" : { "required" : [ "name", "policy" ], "type" : "object", "properties" : { "breachedPasswordProtection" : { "type" : "boolean", "default" : true }, "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" }, "passwordRequirementIndicator" : { "type" : "boolean", "default" : true }, "policy" : { "$ref" : "#/components/schemas/PasswordPolicyConstraints_PasswordPolicy" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "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" }, "PasswordRestrictionInsertRequest" : { "required" : [ "file", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "file" : { "type" : "string", "format" : "binary" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^[a-zA-Z0-9_\\.\\-]+$", "type" : "string" } } }, "PasswordRestrictionQuotaResponse" : { "type" : "object", "properties" : { "maxSizeInBytes" : { "type" : "integer", "format" : "int32" }, "totalSizeInBytes" : { "type" : "integer", "format" : "int32" } } }, "PasswordRestrictionResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "fileSize" : { "type" : "integer", "format" : "int32" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "uploadedAt" : { "type" : "string", "format" : "date-time" } } }, "PasswordRestrictionUpdateRequest" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "id" : { "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 3, "pattern" : "^[a-zA-Z0-9_\\.\\-]+$", "type" : "string" } } }, "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" } } }, "PhoneBasedIdentityAffirmationAttributeResponse" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } }, "PhoneBasedIdentityAffirmationConfigurationResponse" : { "type" : "object", "properties" : { "dataSources" : { "$ref" : "#/components/schemas/DataSources" }, "failureCountThreshold" : { "type" : "integer", "format" : "int32" }, "phoneNumber" : { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationAttributeResponse" } } }, "PhoneBasedIdentityAffirmationStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/PhoneBasedIdentityAffirmationConfigurationResponse" } } } ] }, "PhoneNumberAccountAttribute_AccountAttribute" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a phone number type attribute", "allOf" : [ { "$ref" : "#/components/schemas/AccountAttribute_AccountAttribute" } ] }, "PhoneNumberRiskAttributeResponse" : { "type" : "object", "properties" : { "nativeClaim" : { "$ref" : "#/components/schemas/NameIdAndDisplayName" } } }, "PhoneNumberRiskStepConfigurationResponse" : { "type" : "object", "properties" : { "forbiddenPhoneTypes" : { "$ref" : "#/components/schemas/ForbiddenPhoneTypesResponse" }, "numberPortingRisk" : { "type" : "boolean" }, "phoneNumber" : { "$ref" : "#/components/schemas/PhoneNumberRiskAttributeResponse" } } }, "PhoneNumberRiskStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/PhoneNumberRiskStepConfigurationResponse" } } } ] }, "PhoneNumber_AccountAttribute_InsertRequest" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a phone number type attribute", "allOf" : [ { "required" : [ "displayName", "frontendHook", "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" }, "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" } } ] }, "Placeholder_NotificationTemplateMetainfo" : { "type" : "object", "properties" : { "placeholder" : { "type" : "string" } }, "description" : "Represents a placeholder" }, "Policies" : { "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/IdReferenceResponse" }, "brand" : { "$ref" : "#/components/schemas/IdReferenceResponse" }, "identityProofing" : { "$ref" : "#/components/schemas/IdReferenceResponse" }, "notificationPolicy" : { "$ref" : "#/components/schemas/IdReferenceResponse" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/IdReferenceResponse" } } }, "PoliciesRequest_ApplicationConfig" : { "required" : [ "adaptiveMFA", "brand", "notificationPolicy", "selfServicePolicy" ], "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "brand" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "identityProofing" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "notificationPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" } }, "description" : "Policy assignments for an application" }, "PoliciesResponse_ApplicationConfig" : { "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "brand" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "identityProofing" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" }, "notificationPolicy" : { "$ref" : "#/components/schemas/ApplicationConfigNotificationPolicyResponse_ApplicationConfig" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/NameAndId_ApplicationConfig" } }, "description" : "Policy assignments for an application" }, "Policies_OrganizationPolicy" : { "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" }, "brand" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" }, "identityProofing" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" }, "notificationPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest_OrganizationPolicy" } }, "description" : "Defines which policy to override for an application. If any of them is set to `null`, that policy won't be overridden by the organization." }, "PolicyOverrides" : { "type" : "object", "properties" : { "adaptiveMFA" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "brand" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "identityProofing" : { "$ref" : "#/components/schemas/NullableIdReferenceRequest" }, "notificationPolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest" }, "selfServicePolicy" : { "$ref" : "#/components/schemas/IdReferenceRequest" } }, "description" : "Defines policy overrides for the variant.\nIf any of them is set to `null`, the policy will be inherited.\nIdentity proofing policy can be unset to 'No verification policy' option by `\"identityProofing\" : { \"id\": null }`" }, "PrincipalResponse_AdminPrincipal" : { "type" : "object", "properties" : { "email" : { "type" : "string", "description" : "Email address of the account, if the account has an email identifier, it's the email identifier, otherwise it's the email native claim" }, "id" : { "type" : "string", "description" : "ID of the admin account" }, "name" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "permissions" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } }, "phone" : { "type" : "string", "description" : "Phone identifier of the account" }, "picture" : { "type" : "string", "description" : "Picture URL of the account" }, "store" : { "type" : "string", "description" : "Identity store of the admin account" }, "uiSettings" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents the UI settings on the admin console" }, "description" : "Represents the UI settings on the admin console" }, "userName" : { "type" : "string" } } }, "PrincipalUpdateRequest_AdminPrincipal" : { "required" : [ "uiSettings" ], "type" : "object", "properties" : { "uiSettings" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : "Represents the UI settings on the admin console" }, "description" : "Represents the UI settings on the admin console" } } }, "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)" }, "ProofingDataStepCompoundAddressField" : { "required" : [ "configuration", "displayName", "id" ], "type" : "object", "description" : "Proofing data step field for compound address", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationDataStepField" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/CompoundAddressFieldConfigurationUpsertRequest" } } } ] }, "ProofingDataStepConfigurationResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "displayText" : { "type" : "string" }, "fields" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/ProofingDataStepFieldResponse" } }, "name" : { "type" : "string" } } }, "ProofingDataStepFieldResponse" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "id" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "nativeClaim", "compoundAddress" ] } }, "discriminator" : { "propertyName" : "type" } }, "ProofingDataStepNativeClaimField" : { "required" : [ "configuration", "displayName", "id" ], "type" : "object", "description" : "Proofing data step field for Native Claim", "allOf" : [ { "$ref" : "#/components/schemas/IdentityVerificationDataStepField" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/IdentityVerificationDataStepNativeClaimConfiguration" } } } ] }, "ProofingDataStepResponse" : { "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/IdentityProofingStepResponse" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/ProofingDataStepConfigurationResponse" } } } ] }, "ProofingNotificationResponse_IdentityProofing" : { "type" : "object", "properties" : { "consentItem" : { "$ref" : "#/components/schemas/NameAndIdResponse_IdentityProofing" }, "consentType" : { "type" : "string", "enum" : [ "mandatory", "mandatoryHidden" ] }, "displayText" : { "$ref" : "#/components/schemas/DisplayTextResponse_IdentityProofing" }, "implicit" : { "type" : "boolean" } } }, "ProofingNotification_IdentityProofing" : { "required" : [ "consentItem", "consentType", "displayText" ], "type" : "object", "properties" : { "consentItem" : { "$ref" : "#/components/schemas/OnlyIdRequest_IdentityProofing" }, "consentType" : { "type" : "string", "enum" : [ "mandatory", "mandatoryHidden" ] }, "displayText" : { "$ref" : "#/components/schemas/DisplayText_IdentityProofing" }, "implicit" : { "type" : "boolean", "default" : false } } }, "RelayStateHandlingResponse_ApplicationConfig" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "passthrough", "specificValue" ] } } }, "RelayStateHandling_ApplicationConfig" : { "required" : [ "type" ], "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "passthrough", "specificValue" ] } }, "discriminator" : { "propertyName" : "type" } }, "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" }, "Result" : { "type" : "object", "properties" : { "failure" : { "type" : "integer", "format" : "int32" }, "success" : { "type" : "integer", "format" : "int32" }, "total" : { "type" : "integer", "format" : "int32" } } }, "RoleAssignmentRequest_Account" : { "required" : [ "organization", "roles" ], "type" : "object", "properties" : { "organization" : { "type" : "string", "description" : "ID of the represented organization" }, "roles" : { "maxItems" : 2147483647, "minItems" : 1, "type" : "array", "description" : "Represents a list of role IDs", "items" : { "$ref" : "#/components/schemas/IdReferenceRequest_Account" } } }, "description" : "Represents a role assignment for an account. By specifying an organization and a list of roles by their IDs, this defines organization-role pairs to be assigned to an account." }, "RoleResponse_Role" : { "type" : "object", "properties" : { "defaultAdminRole" : { "type" : "boolean" }, "defaultRole" : { "type" : "boolean" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "scopes" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string" } } } }, "RoleUpsertRequest_Role" : { "required" : [ "id", "name", "scopes" ], "type" : "object", "properties" : { "defaultAdminRole" : { "type" : "boolean", "default" : false }, "defaultRole" : { "type" : "boolean", "default" : false }, "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" } } } }, "Role_InsertRequest" : { "required" : [ "name", "scopes" ], "type" : "object", "properties" : { "defaultAdminRole" : { "type" : "boolean", "default" : false }, "defaultRole" : { "type" : "boolean", "default" : false }, "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" } } } }, "Rule" : { "required" : [ "action", "criteria", "type" ], "type" : "object", "properties" : { "action" : { "type" : "string" }, "criteria" : { "type" : "string" }, "type" : { "type" : "string" } } }, "RuleManagement" : { "required" : [ "attributeRules", "riskRules" ], "type" : "object", "properties" : { "attributeRules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Rule" } }, "riskRules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Rule" } }, "scoreThreshold" : { "minimum" : 0, "type" : "integer", "format" : "int32" } } }, "RuleManagementResponse" : { "type" : "object", "properties" : { "attributeRules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RuleResponse" } }, "riskRules" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/RuleResponse" } }, "scoreThreshold" : { "type" : "integer", "format" : "int32" } } }, "RuleResponse" : { "type" : "object", "properties" : { "action" : { "type" : "string" }, "criteria" : { "type" : "string" }, "type" : { "type" : "string" } } }, "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" }, "Saml2ClientInsert_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientSaml2ConfigurationUpdateRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "Saml2ClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientSaml2ConfigurationResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "Saml2ClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientSaml2ConfigurationUpdateRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "Saml2Client_InsertRequest" : { "required" : [ "applicationLauncherEntry", "configuration", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "configuration" : { "$ref" : "#/components/schemas/ApplicationClientSaml2ConfigurationUpdateRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "loginUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "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" ] } } }, "Saml2LoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderConfiguration" }, "description" : { "type" : "string" }, "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" } } }, "Saml2LoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "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 } } }, "Saml2MetadataDescriptorResponse_ApplicationConfig" : { "type" : "object", "properties" : { "httpPostBindingUrl" : { "type" : "string" }, "httpRedirectBindingUrl" : { "type" : "string" }, "metadataURL" : { "type" : "string" }, "sha1CertificateFingerprint" : { "type" : "string" }, "sha256CertificateFingerprint" : { "type" : "string" } } }, "Saml2_LoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/Saml2LoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "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 } } }, "ScopeResponse_ApiAccessPolicy" : { "type" : "object", "properties" : { "displayName" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" } } }, "ScopeUpsertRequest_ApiAccessPolicy" : { "required" : [ "id", "name" ], "type" : "object", "properties" : { "id" : { "type" : "string" }, "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_!#$&'()*+,/:;=?@\\[\\].]*$", "type" : "string" } } }, "Scope_InsertRequest" : { "required" : [ "name" ], "type" : "object", "properties" : { "name" : { "maxLength" : 256, "minLength" : 1, "pattern" : "^[a-zA-Z0-9_!#$&'()*+,/:;=?@\\[\\].]*$", "type" : "string" } } }, "SecretVariableInsertRequest" : { "required" : [ "name", "secretValue", "type" ], "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] } } }, "SecretVariableUpdateRequest" : { "required" : [ "id", "name", "type" ], "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string", "description" : "It will not be overridden unless provided." }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] } } }, "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" }, "Select_AccountAttribute_InsertRequest" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a select type attribute", "allOf" : [ { "required" : [ "displayName", "frontendHook", "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" }, "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" } }, { "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" } } } } ] }, "SelfServicePolicyRequestOptionsAccountDeletion_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true }, "linkMaxAgeHours" : { "maximum" : 120, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 24 } }, "description" : "Represents account deletion options for self service policy" }, "SelfServicePolicyRequestOptionsAccountInvitation_SelfServicePolicy" : { "type" : "object", "properties" : { "allowEmailMismatch" : { "type" : "boolean", "default" : false }, "enabled" : { "type" : "boolean", "default" : true }, "forceUsingExternalLogin" : { "type" : "boolean", "default" : false }, "linkMaxAgeHours" : { "maximum" : 720, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 72 } } }, "SelfServicePolicyRequestOptionsApplicationLauncher_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } } }, "SelfServicePolicyRequestOptionsForgottenUsernameReminder_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } }, "description" : "Represents forgotten username reminder options for self service policy" }, "SelfServicePolicyRequestOptionsLockout_SelfServicePolicy" : { "type" : "object", "properties" : { "allowSelfPasswordUnlock" : { "type" : "boolean", "default" : false } } }, "SelfServicePolicyRequestOptionsManageConsents_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } }, "description" : "Represents manage consents options for self service policy" }, "SelfServicePolicyRequestOptionsManagePersonalInformation_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } }, "description" : "Represents manage personal information options for self service policy" }, "SelfServicePolicyRequestOptionsPasskey_SelfServicePolicy" : { "type" : "object", "properties" : { "promotionAtLogin" : { "type" : "boolean", "default" : true }, "promotionAtPasswordChange" : { "type" : "boolean", "default" : true }, "promotionAtRegistration" : { "type" : "boolean", "default" : true } } }, "SelfServicePolicyRequestOptionsPasswordChange_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } }, "description" : "Represents password change options for self service policy" }, "SelfServicePolicyRequestOptionsPasswordInput_SelfServicePolicy" : { "type" : "object", "properties" : { "defer" : { "type" : "boolean", "default" : false } } }, "SelfServicePolicyRequestOptionsPasswordReset_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "linkMaxAgeMinutes" : { "maximum" : 1440, "minimum" : 5, "type" : "integer", "format" : "int32", "default" : 60 }, "passcodeLength" : { "maximum" : 8, "minimum" : 6, "type" : "integer", "format" : "int32", "default" : 6 }, "passcodeMaxAgeMinutes" : { "maximum" : 30, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 6 } }, "description" : "Represents password reset options for self service policy" }, "SelfServicePolicyRequestOptionsPersonalData_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean", "default" : true } }, "description" : "Represents personal data options for self service policy" }, "SelfServicePolicyRequestOptionsRegistration_SelfServicePolicy" : { "required" : [ "verificationOption" ], "type" : "object", "properties" : { "accountLinking" : { "type" : "boolean", "default" : true }, "activation" : { "type" : "boolean", "default" : true }, "enabled" : { "type" : "boolean", "default" : false }, "linkMaxAgeHours" : { "maximum" : 120, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 24 }, "passcodeMaxAgeMinutes" : { "maximum" : 30, "minimum" : 1, "type" : "integer", "format" : "int32", "default" : 6 }, "verificationOption" : { "type" : "string", "default" : "magicLink", "enum" : [ "magicLink", "passcode" ] } }, "description" : "Represents registration options for self service policy" }, "SelfServicePolicyRequestOptions_SelfServicePolicy" : { "required" : [ "accountDeletion", "accountInvitation", "applicationLauncher", "forgottenUsernameReminder", "lockout", "manageConsents", "managePersonalInformation", "passkey", "passwordChange", "passwordInput", "passwordReset", "personalData", "registration" ], "type" : "object", "properties" : { "accountDeletion" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsAccountDeletion_SelfServicePolicy" }, "accountInvitation" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsAccountInvitation_SelfServicePolicy" }, "applicationLauncher" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsApplicationLauncher_SelfServicePolicy" }, "forgottenUsernameReminder" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsForgottenUsernameReminder_SelfServicePolicy" }, "lockout" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsLockout_SelfServicePolicy" }, "manageConsents" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsManageConsents_SelfServicePolicy" }, "managePersonalInformation" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsManagePersonalInformation_SelfServicePolicy" }, "passkey" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsPasskey_SelfServicePolicy" }, "passwordChange" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsPasswordChange_SelfServicePolicy" }, "passwordInput" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsPasswordInput_SelfServicePolicy" }, "passwordReset" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsPasswordReset_SelfServicePolicy" }, "personalData" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsPersonalData_SelfServicePolicy" }, "registration" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptionsRegistration_SelfServicePolicy" } }, "description" : "Represents self service policy options" }, "SelfServicePolicyResponseOptionsAccountDeletion_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "linkMaxAgeHours" : { "type" : "integer", "format" : "int32" } }, "description" : "Represents account deletion options for self service policy" }, "SelfServicePolicyResponseOptionsAccountInvitation_SelfServicePolicy" : { "type" : "object", "properties" : { "allowEmailMismatch" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "forceUsingExternalLogin" : { "type" : "boolean" }, "linkMaxAgeHours" : { "type" : "integer", "format" : "int32" } } }, "SelfServicePolicyResponseOptionsApplicationLauncher_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } } }, "SelfServicePolicyResponseOptionsForgottenUsernameReminder_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } }, "description" : "Represents forgotten username reminder options for self service policy" }, "SelfServicePolicyResponseOptionsLockout_SelfServicePolicy" : { "type" : "object", "properties" : { "allowSelfPasswordUnlock" : { "type" : "boolean" } } }, "SelfServicePolicyResponseOptionsManageConsents_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } }, "description" : "Represents manage consents options for self service policy" }, "SelfServicePolicyResponseOptionsManagePersonalInformation_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } }, "description" : "Represents manage personal information options for self service policy" }, "SelfServicePolicyResponseOptionsPasskey_SelfServicePolicy" : { "type" : "object", "properties" : { "promotionAtLogin" : { "type" : "boolean" }, "promotionAtPasswordChange" : { "type" : "boolean" }, "promotionAtRegistration" : { "type" : "boolean" } } }, "SelfServicePolicyResponseOptionsPasswordChange_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } }, "description" : "Represents password change options for self service policy" }, "SelfServicePolicyResponseOptionsPasswordInput_SelfServicePolicy" : { "type" : "object", "properties" : { "defer" : { "type" : "boolean" } } }, "SelfServicePolicyResponseOptionsPasswordReset_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "linkMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "passcodeLength" : { "type" : "integer", "format" : "int32" }, "passcodeMaxAgeMinutes" : { "type" : "integer", "format" : "int32" } }, "description" : "Represents password reset options for self service policy" }, "SelfServicePolicyResponseOptionsPersonalData_SelfServicePolicy" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" } }, "description" : "Represents personal data options for self service policy" }, "SelfServicePolicyResponseOptionsRegistration_SelfServicePolicy" : { "type" : "object", "properties" : { "accountLinking" : { "type" : "boolean" }, "activation" : { "type" : "boolean" }, "enabled" : { "type" : "boolean" }, "linkMaxAgeHours" : { "type" : "integer", "format" : "int32" }, "passcodeMaxAgeMinutes" : { "type" : "integer", "format" : "int32" }, "verificationOption" : { "type" : "string", "enum" : [ "magicLink", "passcode" ] } }, "description" : "Represents registration options for self service policy" }, "SelfServicePolicyResponseOptions_SelfServicePolicy" : { "type" : "object", "properties" : { "accountDeletion" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsAccountDeletion_SelfServicePolicy" }, "accountInvitation" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsAccountInvitation_SelfServicePolicy" }, "applicationLauncher" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsApplicationLauncher_SelfServicePolicy" }, "forgottenUsernameReminder" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsForgottenUsernameReminder_SelfServicePolicy" }, "lockout" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsLockout_SelfServicePolicy" }, "manageConsents" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsManageConsents_SelfServicePolicy" }, "managePersonalInformation" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsManagePersonalInformation_SelfServicePolicy" }, "passkey" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsPasskey_SelfServicePolicy" }, "passwordChange" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsPasswordChange_SelfServicePolicy" }, "passwordInput" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsPasswordInput_SelfServicePolicy" }, "passwordReset" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsPasswordReset_SelfServicePolicy" }, "personalData" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsPersonalData_SelfServicePolicy" }, "registration" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptionsRegistration_SelfServicePolicy" } }, "description" : "Represents self service policy options" }, "SelfServicePolicyResponse_SelfServicePolicy" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "options" : { "$ref" : "#/components/schemas/SelfServicePolicyResponseOptions_SelfServicePolicy" }, "policyTag" : { "type" : "string" } } }, "SelfServicePolicyUpsertRequest_SelfServicePolicy" : { "required" : [ "id", "name", "options" ], "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" }, "options" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptions_SelfServicePolicy" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "SelfServicePolicy_InsertRequest" : { "required" : [ "name", "options" ], "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" }, "options" : { "$ref" : "#/components/schemas/SelfServicePolicyRequestOptions_SelfServicePolicy" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" } } }, "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" }, "SinchCreateRequestConfiguration" : { "required" : [ "apiKey", "smsUrl" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "from" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "smsUrl" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "SinchInsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SinchCreateRequestConfiguration" } } } ] }, "SinchUpdateRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SinchUpdateRequestConfiguration" } } } ] }, "SinchUpdateRequestConfiguration" : { "required" : [ "smsUrl" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string", "description" : "Setting apiKey to null retains its previous value instead of updating to null." }, "from" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "smsUrl" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "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" } } }, "SocialLoginProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderConfiguration" }, "description" : { "type" : "string" }, "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" } } }, "SocialLoginProviderUpsertRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "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 } } }, "SocialLoginProvider_InsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SocialLoginProviderRequestConfiguration" }, "description" : { "maxLength" : 1024, "minLength" : 0, "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 } } }, "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" } } }, "SplunkConfiguration" : { "type" : "object", "properties" : { "index" : { "type" : "string" }, "sourceType" : { "type" : "string" }, "url" : { "type" : "string" } } }, "SplunkEventStreamingInsertRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SplunkEventStreamingInsertRequest.Configuration" } } } ] }, "SplunkEventStreamingInsertRequest.Configuration" : { "required" : [ "apiKey", "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "index" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "sourceType" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "type" : "string" } } }, "SplunkEventStreamingUpdateRequest" : { "required" : [ "accountEventStreaming", "auditLogStreaming", "configuration", "eventHookLogStreaming", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/EventStreamingUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/SplunkEventStreamingUpdateRequest.Configuration" } } } ] }, "SplunkEventStreamingUpdateRequest.Configuration" : { "required" : [ "url" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 0, "type" : "string" }, "index" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "sourceType" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "url" : { "type" : "string" } } }, "SspClientResponse_ApplicationConfig" : { "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryResponse_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceResponse_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "friendlyLoginPageUrlPart" : { "type" : "string" }, "id" : { "type" : "string" }, "loginUrl" : { "type" : "string" }, "loginUrlShortcut" : { "type" : "string" }, "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "type" : "string" } } }, "SspClientUpdate_ApplicationConfig" : { "required" : [ "applicationLauncherEntry", "id", "name", "type" ], "type" : "object", "properties" : { "applicationDomain" : { "type" : "string" }, "applicationLauncherEntry" : { "$ref" : "#/components/schemas/ApplicationLauncherEntryRequest_ApplicationConfig" }, "baseOrganization" : { "$ref" : "#/components/schemas/IdReferenceRequest_ApplicationConfig" }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "friendlyLoginPageUrlPart" : { "maxLength" : 16, "minLength" : 3, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "id" : { "maxLength" : 36, "minLength" : 1, "type" : "string" }, "loginUrlShortcut" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^[-a-zA-Z0-9]*$", "type" : "string" }, "name" : { "maxLength" : 255, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "ssp", "oauth2", "saml2", "orgPortal", "bridge", "oauth2Simplified", "oauth2Native" ] }, "websiteUrl" : { "maxLength" : 1024, "minLength" : 1, "pattern" : "^$|^\\S(.*\\S)?$", "type" : "string" } } }, "StaticSecretRequest" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest" }, { "type" : "object", "properties" : { "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticSecretRequest_ApplicationConfig" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_ApplicationConfig" }, { "type" : "object", "properties" : { "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticSecretRequest_EventHookFunction" : { "required" : [ "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DefaultValueRequest_EventHookFunction" }, { "type" : "object", "properties" : { "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticSecretRequest_IdentityStore" : { "required" : [ "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_IdentityStore" }, { "type" : "object", "properties" : { "secretValue" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticSecretResponse_EventHookFunction" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } } }, "StaticVariableRequest" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticVariableRequest_ApplicationConfig" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_ApplicationConfig" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticVariableRequest_EventHookFunction" : { "required" : [ "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DefaultValueRequest_EventHookFunction" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticVariableRequest_IdentityStore" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_IdentityStore" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } } ] }, "StaticVariableResponse_EventHookFunction" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] }, "value" : { "type" : "string" } } }, "StatsResponseValue_Stats" : { "type" : "object", "properties" : { "groups" : { "type" : "object", "additionalProperties" : { "type" : "string" } }, "time" : { "type" : "string", "format" : "date-time" }, "value" : { "type" : "number", "format" : "double" } }, "description" : "Represents a time-group-value triplet." }, "StatsResponse_Stats" : { "type" : "object", "properties" : { "links" : { "$ref" : "#/components/schemas/LinksResponse_Stats" }, "values" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/StatsResponseValue_Stats" } } } }, "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" }, "String_AccountAttribute_InsertRequest" : { "required" : [ "displayName", "frontendHook", "id", "indexing", "name", "type" ], "type" : "object", "description" : "Represents a string type attribute", "allOf" : [ { "required" : [ "displayName", "frontendHook", "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" }, "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" } }, { "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" } } } ] }, "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" }, "TelephonyProviderIdReferenceRequest" : { "required" : [ "id" ], "type" : "object", "properties" : { "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string", "description" : "ID of the represented entity" } } }, "TelephonyProviderInsertRequest" : { "required" : [ "name", "type" ], "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" }, "type" : { "type" : "string", "enum" : [ "custom", "infobip", "telesign", "twilio", "sinch" ] } }, "discriminator" : { "propertyName" : "type" } }, "TelephonyProviderListResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "supportedChannels" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "sms", "voice" ] } }, "type" : { "type" : "string", "enum" : [ "custom", "infobip", "telesign", "twilio", "sinch", "strivacity" ] } } }, "TelephonyProviderResponse" : { "type" : "object", "properties" : { "configuration" : { "type" : "object" }, "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "supportedChannels" : { "uniqueItems" : true, "type" : "array", "items" : { "type" : "string", "enum" : [ "sms", "voice" ] } }, "type" : { "type" : "string", "enum" : [ "custom", "infobip", "telesign", "twilio", "sinch", "strivacity" ] } } }, "TelephonyProviderUpdateRequest" : { "required" : [ "id", "name", "type" ], "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" }, "type" : { "type" : "string", "description" : "This field cannot be altered", "enum" : [ "custom", "infobip", "telesign", "twilio", "sinch" ] } }, "discriminator" : { "propertyName" : "type" } }, "TelephonyProvider_IdReference_InsertRequest" : { "type" : "object", "properties" : { } }, "TelesignCreateRequestConfiguration" : { "required" : [ "apiKey", "customerId" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "customerId" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "TelesignInsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/TelesignCreateRequestConfiguration" } } } ] }, "TelesignUpdateRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/TelesignUpdateRequestConfiguration" } } } ] }, "TelesignUpdateRequestConfiguration" : { "required" : [ "customerId" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 200, "minLength" : 1, "type" : "string", "description" : "Setting apiKey to null retains its previous value instead of updating to null." }, "customerId" : { "maxLength" : 200, "minLength" : 1, "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" } } }, "TranslationJson" : { "required" : [ "accountAttribute", "brand", "consent", "externalLoginProvider", "identityProofing", "notificationPolicy" ], "type" : "object", "properties" : { "accountAttribute" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/AccountAttributeTranslation" } } }, "brand" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/BrandTranslation" } }, "consent" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ConsentTranslation" } }, "externalLoginProvider" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/ExternalLoginProviderTranslation" } }, "identityProofing" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/IdentityProofingTranslation" } }, "notificationPolicy" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/NotificationTemplateTranslation" } } } } }, "description" : "Represents an imported translation" }, "TranslationListResponse" : { "type" : "object", "properties" : { "enabled" : { "type" : "boolean" }, "languageCode" : { "type" : "string" }, "uploaded" : { "type" : "boolean" } } }, "TryOutEventHookIdResponse_EventHookFunction" : { "type" : "object", "properties" : { "id" : { "type" : "string", "format" : "uuid" } } }, "TryOutEventHookRequest_EventHookFunction" : { "required" : [ "code" ], "type" : "object", "properties" : { "code" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "JavaScript code to be executed for the event hook function" }, "packageDependencies" : { "type" : "object", "additionalProperties" : { "type" : "string", "description" : "Dependencies used for the event hook function" }, "description" : "Dependencies used for the event hook function" } } }, "TwilioCreateRequestConfiguration" : { "required" : [ "accountId", "authToken", "phoneNumber", "serviceId", "username" ], "type" : "object", "properties" : { "accountId" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "authToken" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "phoneNumber" : { "maxLength" : 30, "minLength" : 1, "type" : "string" }, "serviceId" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "username" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "TwilioInsertRequest" : { "required" : [ "configuration", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderInsertRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/TwilioCreateRequestConfiguration" } } } ] }, "TwilioUpdateRequest" : { "required" : [ "configuration", "id", "name", "type" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/TelephonyProviderUpdateRequest" }, { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/TwilioUpdateRequestConfiguration" } } } ] }, "TwilioUpdateRequestConfiguration" : { "required" : [ "accountId", "phoneNumber", "serviceId", "username" ], "type" : "object", "properties" : { "accountId" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "authToken" : { "maxLength" : 200, "minLength" : 1, "type" : "string", "description" : "Setting authToken to null retains its previous value instead of updating to null." }, "phoneNumber" : { "maxLength" : 30, "minLength" : 1, "type" : "string" }, "serviceId" : { "maxLength" : 200, "minLength" : 1, "type" : "string" }, "username" : { "maxLength" : 200, "minLength" : 1, "type" : "string" } } }, "UpdatePersonalDataOperationRequest" : { "required" : [ "accountId", "identityStore", "operation", "value" ], "type" : "object", "properties" : { "accountId" : { "type" : "string" }, "identityStore" : { "type" : "string" }, "operation" : { "type" : "string", "enum" : [ "updatePersonalData" ] }, "value" : { "type" : "object", "additionalProperties" : { "type" : "object" } } } }, "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" } } }, "VariableInsertRequest" : { "required" : [ "name", "type", "value" ], "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] }, "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } }, "VariableListResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] }, "valueUpdatedAt" : { "type" : "string", "format" : "date-time" } } }, "VariableOverrideResponse" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] }, "value" : { "type" : "string" } } }, "VariableOverrideResponse_ApplicationConfig" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] }, "value" : { "type" : "string" } } }, "VariableOverrideResponse_IdentityStore" : { "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] }, "value" : { "type" : "string" } } }, "VariableOverrideUpsertRequest" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } }, "discriminator" : { "propertyName" : "type" } }, "VariableOverrideUpsertRequest_ApplicationConfig" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } }, "discriminator" : { "propertyName" : "type" } }, "VariableOverrideUpsertRequest_IdentityStore" : { "required" : [ "name", "type" ], "type" : "object", "properties" : { "name" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] } }, "discriminator" : { "propertyName" : "type" } }, "VariableReferenceRequest" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 36, "minLength" : 0, "type" : "string" } } } ] }, "VariableReferenceRequest_ApplicationConfig" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_ApplicationConfig" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 36, "minLength" : 0, "type" : "string" } } } ] }, "VariableReferenceRequest_EventHookFunction" : { "required" : [ "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/DefaultValueRequest_EventHookFunction" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 36, "minLength" : 0, "type" : "string" } } } ] }, "VariableReferenceRequest_IdentityStore" : { "required" : [ "name", "type", "value" ], "type" : "object", "allOf" : [ { "$ref" : "#/components/schemas/VariableOverrideUpsertRequest_IdentityStore" }, { "type" : "object", "properties" : { "value" : { "maxLength" : 36, "minLength" : 0, "type" : "string" } } } ] }, "VariableReferenceResponse_EventHookFunction" : { "type" : "object", "properties" : { "type" : { "type" : "string", "enum" : [ "noValue", "variableReference", "staticVariable", "staticSecret" ] }, "value" : { "type" : "string" } } }, "VariableResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyTag" : { "type" : "string" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] }, "value" : { "type" : "string" }, "valueUpdatedAt" : { "type" : "string", "format" : "date-time" } } }, "VariableUpdateRequest" : { "required" : [ "id", "name", "type", "value" ], "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" }, "policyTag" : { "pattern" : "^[a-z0-9_]{2,32}$", "type" : "string", "description" : "Must be an existing policy tag name" }, "type" : { "type" : "string", "enum" : [ "variable", "secret" ] }, "value" : { "maxLength" : 8192, "minLength" : 0, "type" : "string" } } }, "VariantInsertRequest" : { "required" : [ "consentOverrides", "hookOverrides", "name", "policyOverrides", "target" ], "type" : "object", "properties" : { "consentOverrides" : { "uniqueItems" : true, "type" : "array", "description" : "Defines consent overrides for the variant.\nConsent IDs in the list are required to be unique.\nAdd/override: `{ \"consent\": { \"id\": \"\" }, \"type\": \"[optional|mandatory|mandatoryHidden]\" }`\nRemove: `{ \"consent\": { \"id\": \"\" }, \"type\": null }`\n", "items" : { "$ref" : "#/components/schemas/ConsentOverride" } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "hookOverrides" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/HookOverrideUpsertRequest" }, "description" : "Defines lifecycle event hook overrides for the variant.\nAlternative hook configuration for a specific hook type: `\"HOOK_TYPE\" : {\"id\" : \"\"}`\nRemove hook: `\"HOOK_TYPE\" : {\"id\" : null}`" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string", "description" : "Represents the name of the variant. Must not be 'baseline' (case insensitive)." }, "policyOverrides" : { "$ref" : "#/components/schemas/PolicyOverrides" }, "target" : { "$ref" : "#/components/schemas/BooleanExpressionInsert" } } }, "VariantListResponse" : { "type" : "object", "properties" : { "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "target" : { "$ref" : "#/components/schemas/BooleanExpressionResponse" } } }, "VariantResponse" : { "type" : "object", "properties" : { "consentOverrides" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/Consent" } }, "description" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "hookOverrides" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/EventHookOverride" } }, "id" : { "type" : "string" }, "name" : { "type" : "string" }, "policyOverrides" : { "$ref" : "#/components/schemas/Policies" }, "target" : { "$ref" : "#/components/schemas/BooleanExpressionResponse" } } }, "VariantUpdateRequest" : { "required" : [ "consentOverrides", "hookOverrides", "id", "name", "policyOverrides", "target" ], "type" : "object", "properties" : { "consentOverrides" : { "uniqueItems" : true, "type" : "array", "description" : "Defines consent overrides for the variant.\nConsent IDs in the list are required to be unique.\nAdd/override: `{ \"consent\": { \"id\": \"\" }, \"type\": \"[optional|mandatory|mandatoryHidden]\" }`\nRemove: `{ \"consent\": { \"id\": \"\" }, \"type\": null }`\n", "items" : { "$ref" : "#/components/schemas/ConsentOverride" } }, "description" : { "maxLength" : 1024, "minLength" : 0, "type" : "string" }, "enabled" : { "type" : "boolean", "default" : false }, "hookOverrides" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/HookOverrideUpsertRequest" }, "description" : "Defines lifecycle event hook overrides for the variant.\nAlternative hook configuration for a specific hook type: `\"HOOK_TYPE\" : {\"id\" : \"\"}`\nRemove hook: `\"HOOK_TYPE\" : {\"id\" : null}`" }, "id" : { "pattern" : "^[a-zA-Z0-9-]{1,36}$", "type" : "string" }, "name" : { "maxLength" : 64, "minLength" : 1, "pattern" : "^$|^[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°]([\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*° ]*[\\p{L}\\p{N}\\-.:\\/_(){}\\[\\]|&'\"?!@+*°])?$", "type" : "string", "description" : "Represents the name of the variant. Must not be 'baseline' (case insensitive)." }, "policyOverrides" : { "$ref" : "#/components/schemas/PolicyOverrides" }, "target" : { "$ref" : "#/components/schemas/BooleanExpressionInsert" } } }, "WebAnalyticsResponse_WebAnalytics" : { "type" : "object", "properties" : { "apiKey" : { "type" : "string" }, "configuration" : { "type" : "string" }, "enabled" : { "type" : "boolean" }, "id" : { "type" : "string", "enum" : [ "googleAnalytics", "googleTagManager", "mixpanel", "amplitude" ] } } }, "WebAnalytics_WebAnalytics" : { "required" : [ "apiKey", "configuration", "id" ], "type" : "object", "properties" : { "apiKey" : { "maxLength" : 512, "minLength" : 1, "type" : "string" }, "configuration" : { "maxLength" : 256000, "minLength" : 1, "type" : "string", "description" : "Provider specific configuration in raw text format." }, "enabled" : { "type" : "boolean", "default" : true }, "id" : { "type" : "string", "enum" : [ "googleAnalytics", "googleTagManager", "mixpanel", "amplitude" ] } }, "description" : "Represents web analytics configuration." } }, "securitySchemes" : { "securityScheme" : { "scheme" : "bearer", "type" : "http" } } } }