openapi: 3.0.1 info: title: Gravitee.io - Access Management alerts domain API version: 4.12.0-alpha.3 servers: - url: /management security: - gravitee-auth: [] tags: - name: domain paths: /organizations/{organizationId}/environments/{environmentId}/domains: get: tags: - domain summary: List security domains for an environment description: List all the security domains accessible to the current user. User must have DOMAIN[LIST] permission on the specified environment or organization AND either DOMAIN[READ] permission on each security domain or DOMAIN[READ] permission on the specified environment or DOMAIN[READ] permission on the specified organization.Each returned domain is filtered and contains only basic information such as id, name and description and isEnabled. operationId: listDomains parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 - name: q in: query schema: type: string responses: '200': description: List accessible security domains for current user content: application/json: schema: $ref: '#/components/schemas/DomainPage' '500': description: Internal server error post: tags: - domain summary: Create a security domain. description: Create a security domain. User must have DOMAIN[CREATE] permission on the specified environment or DOMAIN[CREATE] permission on the specified organization operationId: createDomain parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewDomain' required: true responses: '201': description: Domain successfully created content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/_hrid/{hrid}: get: tags: - domain summary: Get a security domain by hrid description: User must have the DOMAIN[READ] permission on the specified domain, environment or organization. Domain will be filtered according to permissions (READ on DOMAIN_USER_ACCOUNT, DOMAIN_IDENTITY_PROVIDER, DOMAIN_FORM, DOMAIN_LOGIN_SETTINGS, DOMAIN_DCR, DOMAIN_SCIM, DOMAIN_SETTINGS) operationId: findDomainByHrid parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: hrid in: path required: true schema: type: string responses: '200': description: Domain content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}: get: tags: - domain summary: Get a security domain description: User must have the DOMAIN[READ] permission on the specified domain, environment or organization. Domain will be filtered according to permissions (READ on DOMAIN_USER_ACCOUNT, DOMAIN_IDENTITY_PROVIDER, DOMAIN_FORM, DOMAIN_LOGIN_SETTINGS, DOMAIN_DCR, DOMAIN_SCIM, DOMAIN_SETTINGS) operationId: findDomain parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: Domain content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error put: tags: - domain summary: Update the security domain description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization. operationId: updateDomain parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDomain' required: true responses: '200': description: Domain successfully updated content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error delete: tags: - domain summary: Delete the security domain description: User must have the DOMAIN[DELETE] permission on the specified domain or DOMAIN[DELETE] permission on the specified environment or DOMAIN[DELETE] permission on the specified organization. operationId: deleteDomain parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '204': description: Domain successfully deleted '500': description: Internal server error patch: tags: - domain summary: Patch the security domain description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization. operationId: patchDomain parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchDomain' required: true responses: '200': description: Domain successfully patched content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/alerts/notifiers: get: tags: - domain summary: List alert notifiers description: List all the alert notifiers of the domain. User must have DOMAIN_ALERT_NOTIFIER[LIST] permission on the specified domain, environment or organization. operationId: listAlertNotifiers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List alert notifiers for current user content: application/json: schema: type: array items: $ref: '#/components/schemas/AlertNotifier' '500': description: Internal server error post: tags: - domain summary: Create an alert notifier description: Create a new alert notifierUser must have DOMAIN_ALERT_NOTIFIER[CREATE] permission on the specified domain, environment or organization. operationId: createAlertNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewAlertNotifier' required: true responses: '200': description: Alert notifier successfully created content: application/json: schema: $ref: '#/components/schemas/AlertNotifier' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/alerts/notifiers/{notifierId}: get: tags: - domain summary: Get an alert notifier description: Get an alert notifier by its id. User must have DOMAIN_ALERT_NOTIFIER[LIST] permission on the specified domain, environment or organization. operationId: getAlertNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: notifierId in: path required: true schema: type: string responses: '200': description: The alert notifier content: application/json: schema: $ref: '#/components/schemas/AlertNotifier' '500': description: Internal server error delete: tags: - domain summary: Delete an alert notifier description: Delete an alert notifier by its id. User must have DOMAIN_ALERT_NOTIFIER[DELETE] permission on the specified domain, environment or organization. operationId: deleteAlertNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: notifierId in: path required: true schema: type: string responses: '204': description: Alert notifier successfully deleted '500': description: Internal server error patch: tags: - domain summary: Update an alert notifier description: Update an alert notifierUser must have DOMAIN_ALERT_NOTIFIER[UPDATE] permission on the specified domain, environment or organization. operationId: patchAlertNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: notifierId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchAlertNotifier' required: true responses: '200': description: Alert notifier successfully updated content: application/json: schema: $ref: '#/components/schemas/AlertNotifier' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/alerts/triggers: get: tags: - domain summary: List alert triggers description: List all the alert triggers of the domain accessible to the current user. User must have DOMAIN_ALERT[LIST] permission on the specified domain, environment or organization. operationId: listAlertTriggers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List alert triggers for current user content: application/json: schema: type: array items: $ref: '#/components/schemas/AlertTrigger' '500': description: Internal server error patch: tags: - domain summary: Update multiple alert triggers description: Update multiple alert triggers in the same timeUser must have DOMAIN_ALERT[UPDATE] permission on the specified domain, environment or organization. operationId: updateAlertTriggers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/PatchAlertTrigger' required: true responses: '200': description: Alert triggers successfully updated content: application/json: schema: type: array items: $ref: '#/components/schemas/AlertTrigger' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/analytics: get: tags: - domain summary: Find domain analytics description: User must have DOMAIN_ANALYTICS[READ] permission on the specified domain or DOMAIN_ANALYTICS[READ] permission on the specified environment or DOMAIN_ANALYTICS[READ] permission on the specified organization operationId: findDomainAnalytics parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: from in: query description: Used to define the start date of the time window to query schema: type: integer format: int64 - name: to in: query description: Used to define the end date of the time window to query schema: type: integer format: int64 - name: interval in: query description: The time interval when getting histogram data schema: type: integer format: int64 - name: size in: query description: The number of data to retrieve schema: type: integer format: int32 - name: type in: query description: The type of data to retrieve (group_by, date_histo, count) required: true schema: $ref: '#/components/schemas/AnalyticsTypeParam' - name: field in: query schema: type: string responses: '200': description: Analytics successfully fetched '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications: get: tags: - domain summary: List registered applications for a security domain description: User must have the APPLICATION[LIST] permission on the specified domain, environment or organization AND either APPLICATION[READ] permission on each domain's application or APPLICATION[READ] permission on the specified domain or APPLICATION[READ] permission on the specified environment or APPLICATION[READ] permission on the specified organization. Each returned application is filtered and contains only basic information such as id, name, description and isEnabled. operationId: listApplications parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 - name: q in: query schema: type: string - name: expand in: query schema: type: array items: type: string responses: '200': description: List registered applications for a security domain content: application/json: schema: $ref: '#/components/schemas/ApplicationPage' '500': description: Internal server error post: tags: - domain summary: Create an application description: User must have APPLICATION[CREATE] permission on the specified domain or APPLICATION[CREATE] permission on the specified environment or APPLICATION[CREATE] permission on the specified organization operationId: createApplication parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewApplication' required: true responses: '201': description: Application successfully created content: application/json: schema: $ref: '#/components/schemas/Application' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}: get: tags: - domain summary: Get an application description: User must have the APPLICATION[READ] permission on the specified application or APPLICATION[READ] permission on the specified domain or APPLICATION[READ] permission on the specified environment or APPLICATION[READ] permission on the specified organization. Application will be filtered according to permissions (READ on APPLICATION_IDENTITY_PROVIDER, APPLICATION_CERTIFICATE, APPLICATION_METADATA, APPLICATION_USER_ACCOUNT, APPLICATION_SETTINGS) operationId: findApplication parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '200': description: Application content: application/json: schema: $ref: '#/components/schemas/Application' '500': description: Internal server error put: tags: - domain summary: Update an application description: User must have APPLICATION[UPDATE] permission on the specified application or APPLICATION[UPDATE] permission on the specified domain or APPLICATION[UPDATE] permission on the specified environment or APPLICATION[UPDATE] permission on the specified organization operationId: updateApplication parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchApplication' required: true responses: '200': description: Application successfully updated content: application/json: schema: $ref: '#/components/schemas/Application' '500': description: Internal server error delete: tags: - domain summary: Delete an application description: User must have APPLICATION[DELETE] permission on the specified application or APPLICATION[DELETE] permission on the specified domain or APPLICATION[DELETE] permission on the specified environment or APPLICATION[DELETE] permission on the specified organization operationId: deleteApplication parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '204': description: Application successfully deleted '500': description: Internal server error patch: tags: - domain summary: Patch an application description: User must have APPLICATION[UPDATE] permission on the specified application or APPLICATION[UPDATE] permission on the specified domain or APPLICATION[UPDATE] permission on the specified environment or APPLICATION[UPDATE] permission on the specified organization operationId: patchApplication parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchApplication' required: true responses: '200': description: Application successfully patched content: application/json: schema: $ref: '#/components/schemas/Application' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/analytics: get: tags: - domain summary: Find application analytics description: User must have APPLICATION_ANALYTICS[READ] permission on the specified application or APPLICATION_ANALYTICS[READ] permission on the specified domain or APPLICATION_ANALYTICS[READ] permission on the specified environment or APPLICATION_ANALYTICS[READ] permission on the specified organization operationId: getApplicationAnalytics parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: from in: query description: Used to define the start date of the time window to query schema: type: integer format: int64 - name: to in: query description: Used to define the end date of the time window to query schema: type: integer format: int64 - name: interval in: query description: The time interval when getting histogram data schema: type: integer format: int64 - name: size in: query description: The number of data to retrieve schema: type: integer format: int32 - name: type in: query description: The type of data to retrieve (group_by, date_histo, count) required: true schema: $ref: '#/components/schemas/AnalyticsTypeParam' - name: field in: query schema: type: string responses: '200': description: Analytics successfully fetched '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/emails: get: tags: - domain summary: Find a email for an application description: User must have APPLICATION_EMAIL_TEMPLATE[READ] permission on the specified application or APPLICATION_EMAIL_TEMPLATE[READ] permission on the specified domain or APPLICATION_EMAIL_TEMPLATE[READ] permission on the specified environment or APPLICATION_EMAIL_TEMPLATE[READ] permission on the specified organization operationId: findApplicationEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: template in: query required: true schema: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT responses: '200': description: Email successfully fetched '500': description: Internal server error post: tags: - domain summary: Create a email for an application description: User must have APPLICATION_EMAIL_TEMPLATE[CREATE] permission on the specified application or APPLICATION_EMAIL_TEMPLATE[CREATE] permission on the specified domain or APPLICATION_EMAIL_TEMPLATE[CREATE] permission on the specified environment or APPLICATION_EMAIL_TEMPLATE[CREATE] permission on the specified organization operationId: createApplicationEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewEmail' required: true responses: '201': description: Email successfully created '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/emails/{email}: put: tags: - domain summary: Update an email for an application description: User must have APPLICATION_EMAIL_TEMPLATE[UPDATE] permission on the specified application or APPLICATION_EMAIL_TEMPLATE[UPDATE] permission on the specified domain or APPLICATION_EMAIL_TEMPLATE[UPDATE] permission on the specified environment or APPLICATION_EMAIL_TEMPLATE[UPDATE] permission on the specified organization operationId: updateApplicationEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: email in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEmail' required: true responses: '201': description: Email successfully updated content: application/json: schema: $ref: '#/components/schemas/Email' '500': description: Internal server error delete: tags: - domain summary: Delete an email for an application description: User must have APPLICATION_EMAIL_TEMPLATE[DELETE] permission on the specified application or APPLICATION_EMAIL_TEMPLATE[DELETE] permission on the specified domain or APPLICATION_EMAIL_TEMPLATE[DELETE] permission on the specified environment or APPLICATION_EMAIL_TEMPLATE[DELETE] permission on the specified organization operationId: deleteApplicationEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: email in: path required: true schema: type: string responses: '204': description: Email successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/flows: get: tags: - domain summary: List registered flows for an application description: User must have the APPLICATION_FLOW[LIST] permission on the specified domain or APPLICATION_FLOW[LIST] permission on the specified environment or APPLICATION_FLOW[LIST] permission on the specified organization. Except if user has APPLICATION_FLOW[READ] permission on the domain, environment or organization, each returned flow is filtered and contains only basic information such as id and name and isEnabled. operationId: listAppFlows parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '200': description: List registered flows for an application content: application/json: schema: type: array items: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error put: tags: - domain summary: Create or update list of flows description: User must have the APPLICATION_FLOW[UPDATE] permission on the specified domain or APPLICATION_FLOW[UPDATE] permission on the specified environment or APPLICATION_FLOW[UPDATE] permission on the specified organization operationId: defineAppFlows parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Flow' required: true responses: '200': description: Flows successfully updated content: application/json: schema: type: array items: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/flows/{flow}: get: tags: - domain summary: Get a flow description: User must have the APPLICATION_FLOW[READ] permission on the specified domain or APPLICATION_FLOW[READ] permission on the specified environment or APPLICATION_FLOW[READ] permission on the specified organization operationId: getAppFlow parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: flow in: path required: true schema: type: string responses: '200': description: Flow content: application/json: schema: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error put: tags: - domain summary: Update a flow description: User must have the APPLICATION_FLOW[UPDATE] permission on the specified domain or APPLICATION_FLOW[UPDATE] permission on the specified environment or APPLICATION_FLOW[UPDATE] permission on the specified organization operationId: updateAppFlow parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: flow in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Flow' required: true responses: '201': description: Flow successfully updated content: application/json: schema: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/forms: get: tags: - domain summary: Find a form for an application description: User must have APPLICATION_FORM[READ] permission on the specified application or APPLICATION_FORM[READ] permission on the specified domain or APPLICATION_FORM[READ] permission on the specified environment or APPLICATION_FORM[READ] permission on the specified organization operationId: findApplicationForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: template in: query required: true schema: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT responses: '200': description: Form successfully fetched '500': description: Internal server error post: tags: - domain summary: Create a form for an application description: User must have APPLICATION_FORM[CREATE] permission on the specified application or APPLICATION_FORM[CREATE] permission on the specified domain or APPLICATION_FORM[CREATE] permission on the specified environment or APPLICATION_FORM[CREATE] permission on the specified organization operationId: createApplicationForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewForm' required: true responses: '201': description: Form successfully created '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/forms/{form}: put: tags: - domain summary: Update a form for an application description: User must have APPLICATION_FORM[UPDATE] permission on the specified application or APPLICATION_FORM[UPDATE] permission on the specified domain or APPLICATION_FORM[UPDATE] permission on the specified environment or APPLICATION_FORM[UPDATE] permission on the specified organization operationId: updateApplicationForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: form in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateForm' required: true responses: '201': description: Form successfully updated content: application/json: schema: $ref: '#/components/schemas/Form' '500': description: Internal server error delete: tags: - domain summary: Delete a form for an application description: User must have APPLICATION_FORM[DELETE] permission on the specified application or APPLICATION_FORM[DELETE] permission on the specified domain or APPLICATION_FORM[DELETE] permission on the specified environment or APPLICATION_FORM[DELETE] permission on the specified organization operationId: deleteApplicationForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: form in: path required: true schema: type: string responses: '204': description: Form successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members: get: tags: - domain summary: List members for an application description: User must have APPLICATION_MEMBER[LIST] permission on the specified application or APPLICATION_MEMBER[LIST] permission on the specified domain or APPLICATION_MEMBER[LIST] permission on the specified environment or APPLICATION_MEMBER[LIST] permission on the specified organization operationId: getMembers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '200': description: List members for an application content: application/json: schema: $ref: '#/components/schemas/MembershipListItem' '500': description: Internal server error post: tags: - domain summary: Add or update an application member description: User must have APPLICATION_MEMBER[CREATE] permission on the specified application or APPLICATION_MEMBER[CREATE] permission on the specified domain or APPLICATION_MEMBER[CREATE] permission on the specified environment or APPLICATION_MEMBER[CREATE] permission on the specified organization operationId: addOrUpdateMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewMembership' required: true responses: '201': description: Member has been added or updated successfully '400': description: Membership parameter is not valid '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members/permissions : get: tags: - domain summary: List application member's permissions description: User must have APPLICATION[READ] permission on the specified application or APPLICATION[READ] permission on the specified domain or APPLICATION[READ] permission on the specified environment or APPLICATION[READ] permission on the specified organization operationId: getApplicationMemberPermissions parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '200': description: Application member's permissions content: application/json: schema: type: string '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/members/{member}: delete: tags: - domain summary: Remove a membership description: User must have APPLICATION_MEMBER[DELETE] permission on the specified application or APPLICATION_MEMBER[DELETE] permission on the specified domain or APPLICATION_MEMBER[DELETE] permission on the specified environment or APPLICATION_MEMBER[DELETE] permission on the specified organization operationId: removeApplicationMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: member in: path required: true schema: type: string responses: '204': description: Membership successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources: get: tags: - domain summary: List resources for an application description: User must have APPLICATION_RESOURCE[LIST] permission on the specified application or APPLICATION_RESOURCE[LIST] permission on the specified domain or APPLICATION_RESOURCE[LIST] permission on the specified environment or APPLICATION_RESOURCE[LIST] permission on the specified organization operationId: listApplicationResources parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 responses: '200': description: List resources for an application content: application/json: schema: $ref: '#/components/schemas/ResourceListItem' '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource} : get: tags: - domain summary: Get a resource for an application description: User must have APPLICATION_RESOURCE[READ] permission on the specified application or APPLICATION_RESOURCE[READ] permission on the specified domain or APPLICATION_RESOURCE[READ] permission on the specified environment or APPLICATION_RESOURCE[READ] permission on the specified organization operationId: getApplicationResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: resource in: path required: true schema: type: string responses: '200': description: Get a resource for an application content: application/json: schema: $ref: '#/components/schemas/Resource' '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource}/policies : get: tags: - domain summary: Get resource access policies description: User must have APPLICATION_RESOURCE[READ] permission on the specified application or APPLICATION_RESOURCE[READ] permission on the specified domain or APPLICATION_RESOURCE[READ] permission on the specified environment or APPLICATION_RESOURCE[READ] permission on the specified organization operationId: listApplicationPolicies parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: resource in: path required: true schema: type: string responses: '200': description: Get resource access policies content: application/json: schema: type: array items: $ref: '#/components/schemas/AccessPolicyListItem' '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/resources/{resource}/policies/{policy} : get: tags: - domain summary: Get resource access policy description: User must have APPLICATION_RESOURCE[READ] permission on the specified application or APPLICATION_RESOURCE[READ] permission on the specified domain or APPLICATION_RESOURCE[READ] permission on the specified environment or APPLICATION_RESOURCE[READ] permission on the specified organization operationId: getApplicationResourcePolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: resource in: path required: true schema: type: string - name: policy in: path required: true schema: type: string responses: '200': description: Get resource access policy content: application/json: schema: $ref: '#/components/schemas/AccessPolicy' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets: get: tags: - domain summary: List secrets of an application description: User must have APPLICATION_OPENID[LIST] permission on the specified application or APPLICATION_OPENID[LIST] permission on the specified domain or APPLICATION_OPENID[LIST] permission on the specified environment or APPLICATION_OPENID[LIST] permission on the specified organization operationId: listSecrets parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string responses: '200': description: List secrets of an application content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error post: tags: - domain summary: Create a secret for an application description: User must have APPLICATION_OPENID[CREATE] permission on the specified application or APPLICATION_OPENID[CREATE] permission on the specified domain or APPLICATION_OPENID[CREATE] permission on the specified environment or APPLICATION_OPENID[CREATE] permission on the specified organization operationId: createSecret parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewClientSecret' required: true responses: '200': description: Application secret successfully created content: application/json: schema: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets/{secret}: delete: tags: - domain summary: Delete a secret of an application description: User must have APPLICATION_OPENID[DELETE] permission on the specified application or APPLICATION_OPENID[DELETE] permission on the specified domain or APPLICATION_OPENID[DELETE] permission on the specified environment or APPLICATION_OPENID[DELETE] permission on the specified organization operationId: deleteClientSecret parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: secret in: path required: true schema: type: string responses: '204': description: Secret successfully deleted '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/secrets/{secret}/_renew : post: tags: - domain summary: Renew application secret description: User must have APPLICATION_OPENID[UPDATE] permission on the specified application or APPLICATION_OPENID[UPDATE] permission on the specified domain or APPLICATION_OPENID[UPDATE] permission on the specified environment or APPLICATION_OPENID[UPDATE] permission on the specified organization operationId: renewClientSecret parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string - name: secret in: path required: true schema: type: string responses: '200': description: Application secret successfully updated content: application/json: schema: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/applications/{application}/type: put: tags: - domain summary: Update an application type description: User must have APPLICATION[UPDATE] permission on the specified application or APPLICATION[UPDATE] permission on the specified domain or APPLICATION[UPDATE] permission on the specified environment or APPLICATION[UPDATE] permission on the specified organization operationId: updateApplicationType parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: application in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchApplicationType' required: true responses: '200': description: Application type successfully updated content: application/json: schema: $ref: '#/components/schemas/Application' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits: get: tags: - domain summary: List audit logs for a security domain description: User must have the DOMAIN_AUDIT[LIST] permission on the specified domain, environment or organization. Except if user has ORGANIZATION_AUDIT[READ] permission on the domain, environment or organization, each returned audit is filtered and contains only basic information such as id, date, event, actor, target and status. operationId: listDomainAudits parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: type in: query schema: type: string - name: status in: query schema: type: string - name: user in: query schema: type: string - name: from in: query schema: type: integer format: int64 - name: to in: query schema: type: integer format: int64 - name: size in: query schema: type: integer format: int32 default: 10 - name: page in: query schema: type: integer format: int32 default: 0 responses: '200': description: List audit logs for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/Audit' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/audits/{audit}: get: tags: - domain summary: Get an audit log description: User must have the DOMAIN_AUDIT[READ] permission on the specified domain or DOMAIN_AUDIT[READ] permission on the specified environment or DOMAIN_AUDIT[READ] permission on the specified organization operationId: getDomainAudit parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: audit in: path required: true schema: type: string responses: '200': description: Audit log successfully fetched content: application/json: schema: $ref: '#/components/schemas/Audit' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/auth-device-notifiers: get: tags: - domain summary: List registered Authentication Device Notifiers for a security domain description: User must have the DOMAIN_AUTHDEVICE_NOTIFIER[LIST] permission on the specified domain or DOMAIN_AUTHDEVICE_NOTIFIER[LIST] permission on the specified environment or DOMAIN_AUTHDEVICE_NOTIFIER[LIST] permission on the specified organization Each returned Authentication Device Notifier is filtered and contains only basic information such as id, name. operationId: listAuthenticationDeviceNotifiers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered Authentication Device Notifiers for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthenticationDeviceNotifier' '500': description: Internal server error post: tags: - domain summary: Create an Authentication Device Notifier description: User must have the DOMAIN_AUTHDEVICE_NOTIFIER[CREATE] permission on the specified domain or DOMAIN_AUTHDEVICE_NOTIFIER[CREATE] permission on the specified environment or DOMAIN_AUTHDEVICE_NOTIFIER[CREATE] permission on the specified organization operationId: createAuthenticationDeviceNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewAuthenticationDeviceNotifier' required: true responses: '201': description: Authentication Device Notifier successfully created '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/auth-device-notifiers/{authDeviceNotifier}: get: tags: - domain summary: Get an Authentication Device Notifier description: User must have the DOMAIN_AUTHDEVICE_NOTIFIER[READ] permission on the specified domain or DOMAIN_AUTHDEVICE_NOTIFIER[READ] permission on the specified environment or DOMAIN_AUTHDEVICE_NOTIFIER[READ] permission on the specified organization operationId: getAuthenticationDeviceNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: authDeviceNotifier in: path required: true schema: type: string responses: '200': description: Authentication Device Notifier successfully fetched content: application/json: schema: $ref: '#/components/schemas/AuthenticationDeviceNotifier' '500': description: Internal server error put: tags: - domain summary: Update an Authentication Device Notifier description: User must have the DOMAIN_AUTHDEVICE_NOTIFIER[UPDATE] permission on the specified domain or DOMAIN_AUTHDEVICE_NOTIFIER[UPDATE] permission on the specified environment or DOMAIN_AUTHDEVICE_NOTIFIER[UPDATE] permission on the specified organization operationId: updateAuthenticationDeviceNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: authDeviceNotifier in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuthenticationDeviceNotifier' required: true responses: '201': description: Authentication Device Notifier successfully updated content: application/json: schema: $ref: '#/components/schemas/AuthenticationDeviceNotifier' '500': description: Internal server error delete: tags: - domain summary: Delete an Authentication Device Notifier description: User must have the DOMAIN_AUTHDEVICE_NOTIFIER[DELETE] permission on the specified domain or DOMAIN_AUTHDEVICE_NOTIFIER[DELETE] permission on the specified environment or DOMAIN_AUTHDEVICE_NOTIFIER[DELETE] permission on the specified organization operationId: deleteAuthenticationDeviceNotifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: authDeviceNotifier in: path required: true schema: type: string responses: '204': description: Authentication Device Notifier successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/authorization-engines: get: tags: - domain summary: List registered authorization engines for a security domain description: User must have the DOMAIN_AUTHORIZATION_ENGINE[LIST] permission on the specified domain or DOMAIN_AUTHORIZATION_ENGINE[LIST] permission on the specified environment or DOMAIN_AUTHORIZATION_ENGINE[LIST] permission on the specified organization. operationId: listAuthorizationEngines parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered authorization engines for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/AuthorizationEngine' '500': description: Internal server error post: tags: - domain summary: Create an authorization engine description: User must have the DOMAIN_AUTHORIZATION_ENGINE[CREATE] permission on the specified domain or DOMAIN_AUTHORIZATION_ENGINE[CREATE] permission on the specified environment or DOMAIN_AUTHORIZATION_ENGINE[CREATE] permission on the specified organization operationId: createAuthorizationEngine parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewAuthorizationEngine' required: true responses: '201': description: Authorization engine successfully created content: application/json: schema: $ref: '#/components/schemas/AuthorizationEngine' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/authorization-engines/{engineId}: get: tags: - domain summary: Get an authorization engine description: User must have the DOMAIN_AUTHORIZATION_ENGINE[READ] permission on the specified domain or DOMAIN_AUTHORIZATION_ENGINE[READ] permission on the specified environment or DOMAIN_AUTHORIZATION_ENGINE[READ] permission on the specified organization operationId: findAuthorizationEngine parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: engineId in: path required: true schema: type: string responses: '200': description: Authorization engine content: application/json: schema: $ref: '#/components/schemas/AuthorizationEngine' '500': description: Internal server error put: tags: - domain summary: Update an authorization engine description: User must have the DOMAIN_AUTHORIZATION_ENGINE[UPDATE] permission on the specified domain or DOMAIN_AUTHORIZATION_ENGINE[UPDATE] permission on the specified environment or DOMAIN_AUTHORIZATION_ENGINE[UPDATE] permission on the specified organization operationId: updateAuthorizationEngine parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: engineId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateAuthorizationEngine' required: true responses: '200': description: Authorization engine successfully updated content: application/json: schema: $ref: '#/components/schemas/AuthorizationEngine' '500': description: Internal server error delete: tags: - domain summary: Delete an authorization engine description: User must have the DOMAIN_AUTHORIZATION_ENGINE[DELETE] permission on the specified domain or DOMAIN_AUTHORIZATION_ENGINE[DELETE] permission on the specified environment or DOMAIN_AUTHORIZATION_ENGINE[DELETE] permission on the specified organization operationId: deleteAuthorizationEngine parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: engineId in: path required: true schema: type: string responses: '204': description: Authorization engine successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/bot-detections: get: tags: - domain summary: List registered bot detections for a security domain description: User must have the DOMAIN_BOT_DETECTION[LIST] permission on the specified domain or DOMAIN_BOT_DETECTION[LIST] permission on the specified environment or DOMAIN_BOT_DETECTION[LIST] permission on the specified organization Each returned bot detections is filtered and contains only basic information such as id, name. operationId: listBotDetections parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered bot detections for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/BotDetection' '500': description: Internal server error post: tags: - domain summary: Create a bot detection description: User must have the DOMAIN_BOT_DETECTION[CREATE] permission on the specified domain or DOMAIN_BOT_DETECTION[CREATE] permission on the specified environment or DOMAIN_BOT_DETECTION[CREATE] permission on the specified organization operationId: createBotDetection parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewBotDetection' required: true responses: '201': description: Bot detection successfully created content: application/json: schema: $ref: '#/components/schemas/BotDetection' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/bot-detections/{botDetection}: get: tags: - domain summary: Get a bot detection description: User must have the DOMAIN_BOT_DETECTION[READ] permission on the specified domain or DOMAIN_BOT_DETECTION[READ] permission on the specified environment or DOMAIN_BOT_DETECTION[READ] permission on the specified organization operationId: getBotDetection parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: botDetection in: path required: true schema: type: string responses: '200': description: Bot detection successfully fetched content: application/json: schema: $ref: '#/components/schemas/BotDetection' '500': description: Internal server error put: tags: - domain summary: Update a bot detection description: User must have the DOMAIN_BOT_DETECTION[UPDATE] permission on the specified domain or DOMAIN_BOT_DETECTION[UPDATE] permission on the specified environment or DOMAIN_BOT_DETECTION[UPDATE] permission on the specified organization operationId: updateBotDetection parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: botDetection in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateBotDetection' required: true responses: '201': description: Bot detection successfully updated content: application/json: schema: $ref: '#/components/schemas/BotDetection' '500': description: Internal server error delete: tags: - domain summary: Delete a bot detection description: User must have the DOMAIN_BOT_DETECTION[DELETE] permission on the specified domain or DOMAIN_BOT_DETECTION[DELETE] permission on the specified environment or DOMAIN_BOT_DETECTION[DELETE] permission on the specified organization operationId: deleteBotDetection parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: botDetection in: path required: true schema: type: string responses: '204': description: Bot detection successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificate-settings: put: tags: - domain summary: Update the security domain certificate settings description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization. This endpoint updates only certificate settings without triggering a full domain reload. operationId: updateDomainCertificateSettings parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CertificateSettings' required: true responses: '200': description: Certificate settings successfully updated content: application/json: schema: $ref: '#/components/schemas/Domain' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificates: get: tags: - domain summary: List registered certificates for a security domain description: User must have the DOMAIN_CERTIFICATE[LIST] permission on the specified domain or DOMAIN_CERTIFICATE[LIST] permission on the specified environment or DOMAIN_CERTIFICATE[LIST] permission on the specified organization. Each returned certificate is filtered and contains only basic information such as id, name and type. operationId: listCertificates parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: use in: query schema: type: string responses: '200': description: List registered certificates for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/CertificateEntity' '500': description: Internal server error post: tags: - domain summary: Create a certificate description: User must have the DOMAIN_CERTIFICATE[CREATE] permission on the specified domain or DOMAIN_CERTIFICATE[CREATE] permission on the specified environment or DOMAIN_CERTIFICATE[CREATE] permission on the specified organization operationId: createCertificate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewCertificate' required: true responses: '201': description: Certificate successfully created content: application/json: schema: $ref: '#/components/schemas/ModifiedCertificateEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificates/rotate: post: tags: - domain summary: Generate a new System a certificate description: User must have the DOMAIN_CERTIFICATE[CREATE] permission on the specified domain or DOMAIN_CERTIFICATE[CREATE] permission on the specified environment or DOMAIN_CERTIFICATE[CREATE] permission on the specified organization operationId: rotateCertificate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '201': description: Certificate successfully created content: application/json: schema: $ref: '#/components/schemas/CertificateEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificates/{certificate}: get: tags: - domain summary: Get a certificate description: User must have the DOMAIN_CERTIFICATE[READ] permission on the specified domain or DOMAIN_CERTIFICATE[READ] permission on the specified environment or DOMAIN_CERTIFICATE[READ] permission on the specified organization operationId: findCertificate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: certificate in: path required: true schema: type: string responses: '200': description: Certificate successfully fetched content: application/json: schema: $ref: '#/components/schemas/CertificateEntity' '500': description: Internal server error put: tags: - domain summary: Update a certificate description: User must have the DOMAIN_CERTIFICATE[UPDATE] permission on the specified domain or DOMAIN_CERTIFICATE[UPDATE] permission on the specified environment or DOMAIN_CERTIFICATE[UPDATE] permission on the specified organization operationId: updateCertificate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: certificate in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateCertificate' required: true responses: '201': description: Certificate successfully updated content: application/json: schema: $ref: '#/components/schemas/ModifiedCertificateEntity' '500': description: Internal server error delete: tags: - domain summary: Delete a certificate description: User must have the DOMAIN_CERTIFICATE[DELETE] permission on the specified domain or DOMAIN_CERTIFICATE[DELETE] permission on the specified environment or DOMAIN_CERTIFICATE[DELETE] permission on the specified organization operationId: deleteCertificate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: certificate in: path required: true schema: type: string responses: '204': description: Certificate successfully deleted '400': description: Certificate is bind to existing clients '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificates/{certificate}/key: get: tags: - domain summary: Get the certificate public key description: User must have the DOMAIN[READ] permission on the specified domain or DOMAIN[READ] permission on the specified environment or DOMAIN[READ] permission on the specified organization operationId: getCertificatePublicKey parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: certificate in: path required: true schema: type: string responses: '200': description: Certificate key successfully fetched content: application/json: schema: type: string '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/certificates/{certificate}/keys: get: tags: - domain summary: Get the certificate public keys description: User must have the DOMAIN[READ] permission on the specified domain or DOMAIN[READ] permission on the specified environment or DOMAIN[READ] permission on the specified organization operationId: getCertificatePublicKeys parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: certificate in: path required: true schema: type: string responses: '200': description: Certificate keys successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/CertificateKey' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/cimd/applications: post: tags: - domain summary: Create an application from a CIMD document URL description: User must have APPLICATION[CREATE] permission on the specified domain operationId: createApplicationFromCimd parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewCimdApplication' required: true responses: '201': description: Application successfully created '400': description: Document invalid or untrusted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/cimd/validate: post: tags: - domain summary: Validate a CIMD URL and return parsed metadata preview description: User must have APPLICATION[CREATE] permission on the specified domain operationId: validateCimdUrl parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/CimdValidationRequest' required: true responses: '200': description: Document validated content: application/json: schema: $ref: '#/components/schemas/CimdValidationResponse' '400': description: Document invalid or untrusted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/device-identifiers: get: tags: - domain summary: List registered device identifiers for a security domain description: User must have the DOMAIN_DEVICE_IDENTIFIERS[LIST] permission on the specified domain or DOMAIN_DEVICE_IDENTIFIERS[LIST] permission on the specified environment or DOMAIN_DEVICE_IDENTIFIERS[LIST] permission on the specified organization Each returned bot detections is filtered and contains only basic information such as id, name. operationId: listDeviceIdentifiers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered device identifiers for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/DeviceIdentifier' '500': description: Internal server error post: tags: - domain summary: Create a device identifier description: User must have the DOMAIN_DEVICE_IDENTIFIER[CREATE] permission on the specified domain or DOMAIN_DEVICE_IDENTIFIER[CREATE] permission on the specified environment or DOMAIN_DEVICE_IDENTIFIER[CREATE] permission on the specified organization operationId: createDeviceIdentifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewDeviceIdentifier' required: true responses: '201': description: Device identifiers successfully created content: application/json: schema: $ref: '#/components/schemas/DeviceIdentifier' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/device-identifiers/{deviceIdentifier}: get: tags: - domain summary: Get a Device identifier description: User must have the DOMAIN_DEVICE_IDENTIFIER[READ] permission on the specified domain or DOMAIN_DEVICE_IDENTIFIER[READ] permission on the specified environment or DOMAIN_DEVICE_IDENTIFIER[READ] permission on the specified organization operationId: getDeviceIdentifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: deviceIdentifier in: path required: true schema: type: string responses: '200': description: Device identifier successfully fetched content: application/json: schema: $ref: '#/components/schemas/DeviceIdentifier' '500': description: Internal server error put: tags: - domain summary: Update a Device identifier description: User must have the DOMAIN_DEVICE_IDENTIFIER[UPDATE] permission on the specified domain or DOMAIN_DEVICE_IDENTIFIER[UPDATE] permission on the specified environment or DOMAIN_DEVICE_IDENTIFIER[UPDATE] permission on the specified organization operationId: updateDeviceIdentifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: deviceIdentifier in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateDeviceIdentifier' required: true responses: '201': description: Device identifier successfully updated content: application/json: schema: $ref: '#/components/schemas/DeviceIdentifier' '500': description: Internal server error delete: tags: - domain summary: Delete a Device identifier description: User must have the DOMAIN_DEVICE_IDENTIFIER[DELETE] permission on the specified domain or DOMAIN_DEVICE_IDENTIFIER[DELETE] permission on the specified environment or DOMAIN_DEVICE_IDENTIFIER[DELETE] permission on the specified organization operationId: deleteDeviceIdentifier parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: deviceIdentifier in: path required: true schema: type: string responses: '204': description: Device identifier successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/emails: get: tags: - domain summary: Find a email description: User must have the DOMAIN_EMAIL_TEMPLATE[READ] permission on the specified domain or DOMAIN_EMAIL_TEMPLATE[READ] permission on the specified environment or DOMAIN_EMAIL_TEMPLATE[READ] permission on the specified organization operationId: findEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: template in: query required: true schema: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT responses: '200': description: Email successfully fetched '500': description: Internal server error post: tags: - domain summary: Create a email description: User must have the DOMAIN_EMAIL_TEMPLATE[CREATE] permission on the specified domain or DOMAIN_EMAIL_TEMPLATE[CREATE] permission on the specified environment or DOMAIN_EMAIL_TEMPLATE[CREATE] permission on the specified organization operationId: createEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewEmail' required: true responses: '201': description: Email successfully created '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/emails/{email}: put: tags: - domain summary: Update an email description: User must have the DOMAIN_EMAIL_TEMPLATE[UPDATE] permission on the specified domain or DOMAIN_EMAIL_TEMPLATE[UPDATE] permission on the specified environment or DOMAIN_EMAIL_TEMPLATE[UPDATE] permission on the specified organization operationId: updateDomainEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: email in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateEmail' required: true responses: '201': description: Email successfully updated content: application/json: schema: $ref: '#/components/schemas/Email' '500': description: Internal server error delete: tags: - domain summary: Delete an email description: User must have the DOMAIN_EMAIL_TEMPLATE[DELETE] permission on the specified domain or DOMAIN_EMAIL_TEMPLATE[DELETE] permission on the specified environment or DOMAIN_EMAIL_TEMPLATE[DELETE] permission on the specified organization operationId: deleteDomainEmail parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: email in: path required: true schema: type: string responses: '204': description: Email successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/entrypoints: get: tags: - domain summary: Get the matching gateway entrypoint of the domain description: User must have the DOMAIN[READ] permission on the specified domain, environment or organization. Domain will be filtered according to permissions (READ on DOMAIN_USER_ACCOUNT, DOMAIN_IDENTITY_PROVIDER, DOMAIN_FORM, DOMAIN_LOGIN_SETTINGS, DOMAIN_DCR, DOMAIN_SCIM, DOMAIN_SETTINGS) operationId: getDomainEntrypoints parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: Domain entrypoint content: application/json: schema: type: array items: $ref: '#/components/schemas/Entrypoint' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/extensionGrants: get: tags: - domain summary: List registered extension grants for a security domain description: User must have the DOMAIN_EXTENSION_GRANT[LIST] permission on the specified domain or DOMAIN_EXTENSION_GRANT[LIST] permission on the specified environment or DOMAIN_EXTENSION_GRANT[LIST] permission on the specified organization. Each returned extension grant is filtered and contains only basic information such as id, name and type. operationId: listExtensionGrants parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered extension grants for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/ExtensionGrant' '500': description: Internal server error post: tags: - domain summary: Create a extension grant description: User must have the DOMAIN_EXTENSION_GRANT[CREATE] permission on the specified domain or DOMAIN_EXTENSION_GRANT[CREATE] permission on the specified environment or DOMAIN_EXTENSION_GRANT[CREATE] permission on the specified organization operationId: createExtensionGrant parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewExtensionGrant' required: true responses: '201': description: Extension grant successfully created content: application/json: schema: $ref: '#/components/schemas/ExtensionGrant' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/extensionGrants/{extensionGrant}: get: tags: - domain summary: Get a extension grant description: User must have the DOMAIN_EXTENSION_GRANT[READ] permission on the specified domain or DOMAIN_EXTENSION_GRANT[READ] permission on the specified environment or DOMAIN_EXTENSION_GRANT[READ] permission on the specified organization operationId: getExtensionGrant parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: extensionGrant in: path required: true schema: type: string responses: '200': description: Extension grant successfully fetched content: application/json: schema: $ref: '#/components/schemas/ExtensionGrant' '500': description: Internal server error put: tags: - domain summary: Update an extension grant description: User must have the DOMAIN_EXTENSION_GRANT[UPDATE] permission on the specified domain or DOMAIN_EXTENSION_GRANT[UPDATE] permission on the specified environment or DOMAIN_EXTENSION_GRANT[UPDATE] permission on the specified organization operationId: updateExtensionGrant parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: extensionGrant in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateExtensionGrant' required: true responses: '201': description: Extension grant successfully updated content: application/json: schema: $ref: '#/components/schemas/ExtensionGrant' '500': description: Internal server error delete: tags: - domain summary: Delete a extension grant description: User must have the DOMAIN_EXTENSION_GRANT[DELETE] permission on the specified domain or DOMAIN_EXTENSION_GRANT[DELETE] permission on the specified environment or DOMAIN_EXTENSION_GRANT[DELETE] permission on the specified organization operationId: deleteExtensionGrant parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: extensionGrant in: path required: true schema: type: string responses: '204': description: Extension grant successfully deleted '400': description: Extension grant is bind to existing clients '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/factors: get: tags: - domain summary: List registered factors for a security domain description: User must have the DOMAIN_FACTOR[LIST] permission on the specified domain or DOMAIN_FACTOR[LIST] permission on the specified environment or DOMAIN_FACTOR[LIST] permission on the specified organization Each returned factor is filtered and contains only basic information such as id, name and factor type. operationId: listFactors parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered factors for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/Factor' '500': description: Internal server error post: tags: - domain summary: Create a factor description: User must have the DOMAIN_FACTOR[CREATE] permission on the specified domain or DOMAIN_FACTOR[CREATE] permission on the specified environment or DOMAIN_FACTOR[CREATE] permission on the specified organization operationId: createFactor parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewFactor' required: true responses: '201': description: Factor successfully created content: application/json: schema: $ref: '#/components/schemas/Factor' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/factors/{factor}: get: tags: - domain summary: Get a factor description: User must have the DOMAIN_FACTOR[READ] permission on the specified domain or DOMAIN_FACTOR[READ] permission on the specified environment or DOMAIN_FACTOR[READ] permission on the specified organization operationId: getFactor parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: factor in: path required: true schema: type: string responses: '200': description: Factor successfully fetched content: application/json: schema: $ref: '#/components/schemas/Factor' '500': description: Internal server error put: tags: - domain summary: Update a factor description: User must have the DOMAIN_FACTOR[UPDATE] permission on the specified domain or DOMAIN_FACTOR[UPDATE] permission on the specified environment or DOMAIN_FACTOR[UPDATE] permission on the specified organization operationId: updateFactor parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: factor in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateFactor' required: true responses: '201': description: Factor successfully updated content: application/json: schema: $ref: '#/components/schemas/Factor' '500': description: Internal server error delete: tags: - domain summary: Delete a factor description: User must have the DOMAIN_FACTOR[DELETE] permission on the specified domain or DOMAIN_FACTOR[DELETE] permission on the specified environment or DOMAIN_FACTOR[DELETE] permission on the specified organization operationId: deleteFactor parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: factor in: path required: true schema: type: string responses: '204': description: Factor successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/flows: get: tags: - domain summary: List registered flows for a security domain description: User must have the DOMAIN_FLOW[LIST] permission on the specified domain or DOMAIN_FLOW[LIST] permission on the specified environment or DOMAIN_FLOW[LIST] permission on the specified organization. Except if user has DOMAIN_FLOW[READ] permission on the domain, environment or organization, each returned flow is filtered and contains only basic information such as id and name and isEnabled. operationId: listDomainFlows parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered flows for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error put: tags: - domain summary: Create or update list of flows description: User must have the DOMAIN_FLOW[UPDATE] permission on the specified domain or DOMAIN_FLOW[UPDATE] permission on the specified environment or DOMAIN_FLOW[UPDATE] permission on the specified organization operationId: defineDomainFlows parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: $ref: '#/components/schemas/Flow' required: true responses: '200': description: Flows successfully updated content: application/json: schema: type: array items: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/flows/{flow}: get: tags: - domain summary: Get a flow description: User must have the DOMAIN_FLOW[READ] permission on the specified domain or DOMAIN_FLOW[READ] permission on the specified environment or DOMAIN_FLOW[READ] permission on the specified organization operationId: getDomainFlow parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: flow in: path required: true schema: type: string responses: '200': description: Flow content: application/json: schema: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error put: tags: - domain summary: Update a flow description: User must have the DOMAIN_FLOW[UPDATE] permission on the specified domain or DOMAIN_FLOW[UPDATE] permission on the specified environment or DOMAIN_FLOW[UPDATE] permission on the specified organization operationId: updateDomainFlow parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: flow in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/Flow' required: true responses: '201': description: Flow successfully updated content: application/json: schema: $ref: '#/components/schemas/FlowEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/forms: get: tags: - domain summary: Find a form description: User must have the DOMAIN_FORM[READ] permission on the specified domain or DOMAIN_FORM[READ] permission on the specified environment or DOMAIN_FORM[READ] permission on the specified organization operationId: findForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: template in: query required: true schema: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT responses: '200': description: Form successfully fetched '500': description: Internal server error post: tags: - domain summary: Create a form description: User must have the DOMAIN_FORM[CREATE] permission on the specified domain or DOMAIN_FORM[CREATE] permission on the specified environment or DOMAIN_FORM[CREATE] permission on the specified organization operationId: createForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewForm' required: true responses: '201': description: Form successfully created '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/forms/preview: post: tags: - domain summary: Render the provided template description: User must have the DOMAIN_THEME[READ] permission on the specified domain or DOMAIN_THEME[READ] permission on the specified environment or DOMAIN_THEME[READ] permission on the specified organization operationId: renderDomainTemplate parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PreviewRequest' required: true responses: '200': description: Template successfully rendered content: application/json: schema: $ref: '#/components/schemas/PreviewResponse' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/forms/{form}: put: tags: - domain summary: Update a form description: User must have the DOMAIN_FORM[UPDATE] permission on the specified domain or DOMAIN_FORM[UPDATE] permission on the specified environment or DOMAIN_FORM[UPDATE] permission on the specified organization operationId: updateDomainForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: form in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateForm' required: true responses: '201': description: Form successfully updated content: application/json: schema: $ref: '#/components/schemas/Form' '500': description: Internal server error delete: tags: - domain summary: Delete a form description: User must have the DOMAIN_FORM[DELETE] permission on the specified domain or DOMAIN_FORM[DELETE] permission on the specified environment or DOMAIN_FORM[DELETE] permission on the specified organization operationId: deleteDomainForm parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: form in: path required: true schema: type: string responses: '204': description: Form successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups: get: tags: - domain summary: List groups for a security domain description: User must have the DOMAIN_GROUP[LIST] permission on the specified domain or DOMAIN_GROUP[LIST] permission on the specified environment or DOMAIN_GROUP[LIST] permission on the specified organization. Each returned group is filtered and contains only basic information such as id and name. operationId: listDomainGroups parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 100 responses: '200': description: List groups for a security domain content: application/json: schema: $ref: '#/components/schemas/GroupPage' '500': description: Internal server error post: tags: - domain summary: Create a group description: User must have the DOMAIN_GROUP[CREATE] permission on the specified domain or DOMAIN_GROUP[CREATE] permission on the specified environment or DOMAIN_GROUP[CREATE] permission on the specified organization operationId: createGroup parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewGroup' required: true responses: '201': description: Group successfully created content: application/json: schema: $ref: '#/components/schemas/Group' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups/{group}: get: tags: - domain summary: Get a group description: User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization operationId: findGroup parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string responses: '200': description: Group successfully fetched content: application/json: schema: $ref: '#/components/schemas/Group' '500': description: Internal server error put: tags: - domain summary: Update a group description: User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization operationId: updateGroup parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateGroup' required: true responses: '201': description: Group successfully updated content: application/json: schema: $ref: '#/components/schemas/Group' '500': description: Internal server error delete: tags: - domain summary: Delete a group description: User must have the DOMAIN_GROUP[DELETE] permission on the specified domain or DOMAIN_GROUP[DELETE] permission on the specified environment or DOMAIN_GROUP[DELETE] permission on the specified organization operationId: deleteGroup parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string responses: '204': description: Group successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups/{group}/members: get: tags: - domain summary: List group members description: User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization operationId: getGroupMembers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 30 responses: '200': description: Group members successfully fetched content: application/json: schema: $ref: '#/components/schemas/UserPage' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups/{group}/members/{member}: post: tags: - domain summary: Add a group member description: User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization operationId: addGroupMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string - name: member in: path required: true schema: type: string responses: '200': description: Member has been added successfully '400': description: User does not exist '500': description: Internal server error delete: tags: - domain summary: Remove a group member description: User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization operationId: removeGroupMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string - name: member in: path required: true schema: type: string responses: '200': description: Member has been removed successfully '400': description: User does not exist '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups/{group}/roles: get: tags: - domain summary: Get a group roles description: User must have the DOMAIN_GROUP[READ] permission on the specified domain or DOMAIN_GROUP[READ] permission on the specified environment or DOMAIN_GROUP[READ] permission on the specified organization operationId: findGroupRoles parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string responses: '200': description: Group roles successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' '500': description: Internal server error post: tags: - domain summary: Assign roles to a group description: User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization operationId: assignRoles parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: Roles successfully assigned content: application/json: schema: $ref: '#/components/schemas/Group' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/groups/{group}/roles/{role}: delete: tags: - domain summary: Revoke role to a group description: User must have the DOMAIN_GROUP[UPDATE] permission on the specified domain or DOMAIN_GROUP[UPDATE] permission on the specified environment or DOMAIN_GROUP[UPDATE] permission on the specified organization operationId: revokeRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: group in: path required: true schema: type: string - name: role in: path required: true schema: type: string responses: '200': description: Roles successfully revoked content: application/json: schema: $ref: '#/components/schemas/Group' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/i18n/dictionaries: get: tags: - domain summary: List all i18n dictionaries supported for a security domain description: User must have the DOMAIN_I18N_DICTIONARY[LIST] permission on the specified domain or DOMAIN_I18N_DICTIONARY[LIST] permission on the specified environment or DOMAIN_I18N_DICTIONARY[LIST] permission on the specified organization. operationId: listI18nDictionaries parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List of i18n dictionaries for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/I18nDictionary' '500': description: Internal server error post: tags: - domain summary: Create a new i18n dictionary for a supported language for a security domain description: User must have the DOMAIN_I18N_DICTIONARY[CREATE] permission on the specified domain or DOMAIN_I18N_DICTIONARY[CREATE] permission on the specified environment or DOMAIN_I18N_DICTIONARY[CREATE] permission on the specified organization. operationId: createI18nDictionary parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/NewDictionary' required: true responses: '201': description: Create a new i18n dictionary for a security domain content: application/json: schema: $ref: '#/components/schemas/I18nDictionary' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/i18n/dictionaries/{dictionary}: get: tags: - domain summary: Get a i18n dictionary description: User must have the DOMAIN_I18N_DICTIONARY[READ] permission on the specified domain or DOMAIN_I18N_DICTIONARY[READ] permission on the specified environment or DOMAIN_I18N_DICTIONARY[READ] permission on the specified organization. operationId: getI18nDictionary parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: dictionary in: path required: true schema: type: string responses: '200': description: Get the i18n dictionary content: application/json: schema: $ref: '#/components/schemas/I18nDictionary' '500': description: Internal server error put: tags: - domain summary: Update a i18n dictionary description description: User must have the DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified domain or DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified environment or DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified organization. operationId: putI18nDictionary parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: dictionary in: path required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/UpdateI18nDictionary' required: true responses: '200': description: Update the i18n dictionary description content: application/json: schema: $ref: '#/components/schemas/I18nDictionary' '500': description: Internal server error delete: tags: - domain summary: Delete a i18n dictionary description: User must have the DOMAIN_I18N_DICTIONARY[DELETE] permission on the specified domain or DOMAIN_I18N_DICTIONARY[DELETE] permission on the specified environment or DOMAIN_I18N_DICTIONARY[DELETE] permission on the specified organization. operationId: deleteI18nDictionary parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: dictionary in: path required: true schema: type: string responses: '200': description: Delete a i18n dictionary from a security domain '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/i18n/dictionaries/{dictionary}/entries: put: tags: - domain summary: Update all the entries for a i18n dictionary description description: User must have the DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified domain or DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified environment or DOMAIN_I18N_DICTIONARY[UPDATE] permission on the specified organization. operationId: replaceI18nDictionaryEntries parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: dictionary in: path required: true schema: type: string requestBody: content: '*/*': schema: type: object additionalProperties: type: string required: true responses: '200': description: Update the i18n entries for the given dictionary content: application/json: schema: $ref: '#/components/schemas/I18nDictionary' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/identities: get: tags: - domain summary: List registered identity providers for a security domain description: User must have the DOMAIN_IDENTITY_PROVIDER[LIST] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[LIST] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[LIST] permission on the specified organization. Each returned identity provider is filtered and contains only basic information such as id, name and type. operationId: listIdentityProviders parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: userProvider in: query schema: type: boolean responses: '200': description: List registered identity providers for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/FilteredIdentityProviderInfo' '500': description: Internal server error post: tags: - domain summary: Create an identity provider description: User must have the DOMAIN_IDENTITY_PROVIDER[CREATE] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[CREATE] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[CREATE] permission on the specified organization operationId: createIdentityProvider parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewIdentityProvider' required: true responses: '201': description: Identity provider successfully created content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/identities/{identity}: get: tags: - domain summary: Get an identity provider description: User must have the DOMAIN_IDENTITY_PROVIDER[READ] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[READ] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[READ] permission on the specified organization operationId: findIdentityProvider parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: identity in: path required: true schema: type: string responses: '200': description: Identity provider content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' '500': description: Internal server error put: tags: - domain summary: Update an identity provider description: User must have the DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified organization operationId: updateIdentityProvider parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: identity in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateIdentityProvider' required: true responses: '201': description: Identity provider successfully updated content: application/json: schema: $ref: '#/components/schemas/IdentityProvider' '500': description: Internal server error delete: tags: - domain summary: Delete an identity provider description: User must have the DOMAIN_IDENTITY_PROVIDER[DELETE] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[DELETE] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[DELETE] permission on the specified organization operationId: deleteIdentityProvider parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: identity in: path required: true schema: type: string responses: '204': description: Identity provider successfully deleted '400': description: Identity provider is bind to existing clients '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/identities/{identity}/password-policy: put: tags: - domain summary: Assign password policy to identity provider description: User must have the DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified domain or DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified environment or DOMAIN_IDENTITY_PROVIDER[UPDATE] permission on the specified organization operationId: assignPasswordPolicyToIdp parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: identity in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/AssignPasswordPolicy' required: true responses: '201': description: Password Policy successfully assigned to Identity provider content: application/json: schema: $ref: '#/components/schemas/AssignPasswordPolicy' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members: get: tags: - domain summary: List members for a security domain description: User must have the DOMAIN_MEMBER[LIST] permission on the specified domain or DOMAIN_MEMBER[LIST] permission on the specified environment or DOMAIN_MEMBER[LIST] permission on the specified organization operationId: listMembers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List members for a security domain content: application/json: schema: $ref: '#/components/schemas/MembershipListItem' '500': description: Internal server error post: tags: - domain summary: Add or update an security domain member description: User must have the DOMAIN_MEMBER[CREATE] permission on the specified domain or DOMAIN_MEMBER[CREATE] permission on the specified environment or DOMAIN_MEMBER[CREATE] permission on the specified organization operationId: addOrUpdateMember_1 parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewMembership' required: true responses: '201': description: Member has been added or updated successfully '400': description: Membership parameter is not valid '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members/permissions: get: tags: - domain summary: List domain member's permissions description: User must have DOMAIN[READ] permission on the specified domain or DOMAIN[READ] permission on the specified environment or DOMAIN[READ] permission on the specified organization operationId: getDomainMemberPermissions parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: Domain member's permissions content: application/json: schema: type: string '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/members/{member}: delete: tags: - domain summary: Remove a membership description: User must have the DOMAIN_MEMBER[DELETE] permission on the specified domain or DOMAIN_MEMBER[DELETE] permission on the specified environment or DOMAIN_MEMBER[DELETE] permission on the specified organization operationId: removeDomainMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: member in: path required: true schema: type: string responses: '204': description: Membership successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/password-policies: get: tags: - domain summary: List registered password policies for a security domain description: 'User must have the DOMAIN_SETTINGS[READ] permission on the specified domain or DOMAIN_SETTINGS[READ] permission on the specified environment or DOMAIN_SETTINGS[READ] permission on the specified organization. ' operationId: listPasswordPolicies parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered password policies for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/PasswordPolicyEntity' '500': description: Internal server error post: tags: - domain summary: Create a password policy description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization operationId: createPasswordPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewPasswordPolicy' required: true responses: '201': description: Password Policy successfully created content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/password-policies/activePolicy: get: tags: - domain operationId: getEffectivePasswordPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: identity in: query schema: type: string responses: default: description: default response content: application/json: {} /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/password-policies/{policy}: get: tags: - domain summary: Read a password policy description: User must have the DOMAIN_SETTINGS[READ] permission on the specified domain or DOMAIN_SETTINGS[READ] permission on the specified environment or DOMAIN_SETTINGS[READ] permission on the specified organization operationId: getPasswordPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: policy in: path required: true schema: type: string responses: '200': description: Password Policy description content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '500': description: Internal server error put: tags: - domain summary: Update a password policy description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization operationId: updatePasswordPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: policy in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdatePasswordPolicy' required: true responses: '200': description: Password Policy successfully updated content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '500': description: Internal server error delete: tags: - domain summary: Delete a password policy description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization operationId: deletePasswordPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: policy in: path required: true schema: type: string responses: '204': description: Password Policy successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/password-policies/{policy}/default: post: tags: - domain summary: Set default policy description: User must have the DOMAIN_SETTINGS[UPDATE] permission on the specified domain or DOMAIN_SETTINGS[UPDATE] permission on the specified environment or DOMAIN_SETTINGS[UPDATE] permission on the specified organization operationId: setDefaultPolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: policy in: path required: true schema: type: string responses: '200': description: Default policy updated content: application/json: schema: $ref: '#/components/schemas/PasswordPolicy' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/password-policies/{policy}/evaluate: post: tags: - domain operationId: evaluatePolicy parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: policy in: path required: true schema: type: string responses: '200': description: Result of evaluating the password against the policy /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources: get: tags: - domain summary: List registered protected resources for a security domain description: User must have the PROTECTED_RESOURCE[LIST] permission on the specified domain, environment or organization AND either PROTECTED_RESOURCE[READ] permission on each domain's protected resource or PROTECTED_RESOURCE[READ] permission on the specified domain or PROTECTED_RESOURCE[READ] permission on the specified environment or PROTECTED_RESOURCE[READ] permission on the specified organization. Each returned protected resource is filtered and contains only basic information such as id, name, description and isEnabled. operationId: listProtectedResources parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: q in: query schema: type: string - name: type in: query schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 - name: sort in: query schema: type: string default: updatedAt.desc responses: '200': description: List registered protected resources for a security domain content: application/json: schema: $ref: '#/components/schemas/ProtectedResourcePage' '500': description: Internal server error post: tags: - domain summary: Create a Protected Resource definition description: User must have PROTECTED_RESOURCE[CREATE] permission on the specified domain or PROTECTED_RESOURCE[CREATE] permission on the specified environment or PROTECTED_RESOURCE[CREATE] permission on the specified organization operationId: createProtectedResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewProtectedResource' required: true responses: '201': description: Protected Resource successfully created content: application/json: schema: $ref: '#/components/schemas/ProtectedResourceSecret' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}: get: tags: - domain summary: Get a Protected Resource description: 'User must have the PROTECTED_RESOURCE[READ] permission on the specified resource or PROTECTED_RESOURCE[READ] permission on the specified domain or PROTECTED_RESOURCE[READ] permission on the specified environment or PROTECTED_RESOURCE[READ] permission on the specified organization. ' operationId: findProtectedResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string - name: type in: query schema: type: string responses: '200': description: Protected Resource content: application/json: schema: $ref: '#/components/schemas/ProtectedResourcePrimaryData' '500': description: Internal server error put: tags: - domain summary: Update a Protected Resource description: 'User must have the PROTECTED_RESOURCE[UPDATE] permission on the specified resource or PROTECTED_RESOURCE[UPDATE] permission on the specified domain or PROTECTED_RESOURCE[UPDATE] permission on the specified environment or PROTECTED_RESOURCE[UPDATE] permission on the specified organization. ' operationId: updateProtectedResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateProtectedResource' required: true responses: '200': description: Protected Resource successfully updated content: application/json: schema: $ref: '#/components/schemas/ProtectedResourcePrimaryData' '500': description: Internal server error delete: tags: - domain summary: Delete a Protected Resource description: 'User must have the PROTECTED_RESOURCE[DELETE] permission on the specified resource or PROTECTED_RESOURCE[DELETE] permission on the specified domain or PROTECTED_RESOURCE[DELETE] permission on the specified environment or PROTECTED_RESOURCE[DELETE] permission on the specified organization. ' operationId: deleteProtectedResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string - name: type in: query schema: type: string responses: '204': description: Protected Resource successfully deleted '404': description: Protected Resource not found '403': description: Forbidden '500': description: Internal server error patch: tags: - domain summary: Patch a Protected Resource description: 'User must have the PROTECTED_RESOURCE[UPDATE] permission on the specified resource or PROTECTED_RESOURCE[UPDATE] permission on the specified domain or PROTECTED_RESOURCE[UPDATE] permission on the specified environment or PROTECTED_RESOURCE[UPDATE] permission on the specified organization. ' operationId: patchProtectedResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchProtectedResource' required: true responses: '200': description: Protected Resource successfully patched content: application/json: schema: $ref: '#/components/schemas/ProtectedResourcePrimaryData' '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members : get: tags: - domain summary: List members for an protected resource description: User must have PROTECTED_RESOURCE_MEMBER[LIST] permission on the specified protected resource or PROTECTED_RESOURCE_MEMBER[LIST] permission on the specified domain or PROTECTED_RESOURCE_MEMBER[LIST] permission on the specified environment or PROTECTED_RESOURCE_MEMBER[LIST] permission on the specified organization operationId: getMembers_1 parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string responses: '200': description: List members for an protected resource content: application/json: schema: $ref: '#/components/schemas/MembershipListItem' '500': description: Internal server error post: tags: - domain summary: Add or update an protected resource member description: User must have PROTECTED_RESOURCE_MEMBER[CREATE] permission on the specified protected resource or PROTECTED_RESOURCE_MEMBER[CREATE] permission on the specified domain or PROTECTED_RESOURCE_MEMBER[CREATE] permission on the specified environment or PROTECTED_RESOURCE_MEMBER[CREATE] permission on the specified organization operationId: addOrUpdateMember_2 parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewMembership' required: true responses: '201': description: Member has been added or updated successfully '400': description: Membership parameter is not valid '404': description: Domain or protected resource is not found '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members/permissions : get: tags: - domain summary: List protected resource member's permissions description: User must have PROTECTED_RESOURCE[READ] permission on the specified protected resource or PROTECTED_RESOURCE[READ] permission on the specified domain or PROTECTED_RESOURCE[READ] permission on the specified environment or PROTECTED_RESOURCE[READ] permission on the specified organization operationId: getProtectedResourceMemberPermissions parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string responses: '200': description: Protected resource member's permissions content: application/json: schema: type: string '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/members/{member} : delete: tags: - domain summary: Remove a membership description: User must have PROTECTED_RESOURCE_MEMBER[DELETE] permission on the specified protected resource or PROTECTED_RESOURCE_MEMBER[DELETE] permission on the specified domain or PROTECTED_RESOURCE_MEMBER[DELETE] permission on the specified environment or PROTECTED_RESOURCE_MEMBER[DELETE] permission on the specified organization operationId: removeProtectedResourceMember parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string - name: member in: path required: true schema: type: string responses: '204': description: Membership successfully deleted '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets : get: tags: - domain summary: List secrets of a protected resource description: User must have the PROTECTED_RESOURCE_OAUTH[LIST] permission on the specified resource or PROTECTED_RESOURCE_OAUTH[LIST] permission on the specified domain or PROTECTED_RESOURCE_OAUTH[LIST] permission on the specified environment or PROTECTED_RESOURCE_OAUTH[LIST] permission on the specified organization. operationId: getSecrets parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string responses: '200': description: List secrets of a protected resource content: application/json: schema: type: array items: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error post: tags: - domain summary: Create a secret for a protected resource description: User must have the PROTECTED_RESOURCE_OAUTH[CREATE] permission on the specified resource or PROTECTED_RESOURCE_OAUTH[CREATE] permission on the specified domain or PROTECTED_RESOURCE_OAUTH[CREATE] permission on the specified environment or PROTECTED_RESOURCE_OAUTH[CREATE] permission on the specified organization. operationId: create parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewClientSecret' required: true responses: '201': description: Protected Resource secret successfully created content: application/json: schema: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets/{secretId} : delete: tags: - domain summary: Remove a secret for a protected resource description: User must have the PROTECTED_RESOURCE_OAUTH[DELETE] permission on the specified resource or PROTECTED_RESOURCE_OAUTH[DELETE] permission on the specified domain or PROTECTED_RESOURCE_OAUTH[DELETE] permission on the specified environment or PROTECTED_RESOURCE_OAUTH[DELETE] permission on the specified organization. operationId: delete parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string - name: secretId in: path required: true schema: type: string responses: '204': description: Protected Resource secret successfully deleted '404': description: Protected Resource or secret not found '500': description: Internal server error ? /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/protected-resources/{protected-resource}/secrets/{secretId}/_renew : post: tags: - domain summary: Renew a secret for a protected resource description: User must have the PROTECTED_RESOURCE_OAUTH[UPDATE] permission on the specified resource or PROTECTED_RESOURCE_OAUTH[UPDATE] permission on the specified domain or PROTECTED_RESOURCE_OAUTH[UPDATE] permission on the specified environment or PROTECTED_RESOURCE_OAUTH[UPDATE] permission on the specified organization. operationId: renew parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: protected-resource in: path required: true schema: type: string - name: secretId in: path required: true schema: type: string responses: '200': description: Protected Resource secret successfully renewed content: application/json: schema: $ref: '#/components/schemas/ClientSecret' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters: get: tags: - domain summary: List registered reporters for a security domain description: User must have the DOMAIN_REPORTER[LIST] permission on the specified domain or DOMAIN_REPORTER[LIST] permission on the specified environment or DOMAIN_REPORTER[LIST] permission on the specified organization. Except if user has DOMAIN_REPORTER[READ] permission on the domain, environment or organization, each returned reporter is filtered and contains only basic information such as id and name and type. operationId: listDomainReporters parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: userProvider in: query schema: type: boolean responses: '200': description: List registered reporters for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/Reporter' '500': description: Internal server error post: tags: - domain summary: Create a reporter for a security domain description: User must have the DOMAIN_REPORTER[CREATE] permission on the specified domain or DOMAIN_REPORTER[CREATE] permission on the specified environment or DOMAIN_REPORTER[CREATE] permission on the specified organization. operationId: createDomainReporter parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewReporter' responses: '201': description: Reporter created for a security domain content: application/json: schema: $ref: '#/components/schemas/Reporter' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/reporters/{reporter}: get: tags: - domain summary: Get a reporter description: User must have the DOMAIN_REPORTER[READ] permission on the specified domain or DOMAIN_REPORTER[READ] permission on the specified environment or DOMAIN_REPORTER[READ] permission on the specified organization operationId: getDomainReporter parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: reporter in: path required: true schema: type: string responses: '200': description: Reporter successfully fetched content: application/json: schema: $ref: '#/components/schemas/Reporter' '500': description: Internal server error put: tags: - domain summary: Update a reporter description: User must have the DOMAIN_REPORTER[UPDATE] permission on the specified domain or DOMAIN_REPORTER[UPDATE] permission on the specified environment or DOMAIN_REPORTER[UPDATE] permission on the specified organization operationId: updateDomainReporter parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: reporter in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateReporter' required: true responses: '201': description: Reporter successfully updated content: application/json: schema: $ref: '#/components/schemas/Reporter' '500': description: Internal server error delete: tags: - domain summary: Delete a reporter description: User must have the DOMAIN_REPORTER[DELETE] permission on the specified domain or DOMAIN_REPORTER[DELETE] permission on the specified environment or DOMAIN_REPORTER[DELETE] permission on the specified organization operationId: deleteDomainReporter parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: reporter in: path required: true schema: type: string responses: '204': description: Reporter successfully removed content: application/json: {} '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/resources: get: tags: - domain summary: List registered resources for a security domain description: User must have the DOMAIN_RESOURCE[LIST] permission on the specified domain or DOMAIN_RESOURCE[LIST] permission on the specified environment or DOMAIN_RESOURCE[LIST] permission on the specified organization Each returned resource is filtered and contains only basic information such as id, name and resource type. operationId: listResources parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List registered resources for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/ServiceResource' '500': description: Internal server error post: tags: - domain summary: Create a resource description: User must have the DOMAIN_RESOURCE[CREATE] permission on the specified domain or DOMAIN_RESOURCE[CREATE] permission on the specified environment or DOMAIN_RESOURCE[CREATE] permission on the specified organization operationId: createResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewServiceResource' required: true responses: '201': description: Resource successfully created content: application/json: schema: $ref: '#/components/schemas/ServiceResource' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/resources/{resource}: get: tags: - domain summary: Get a resource description: User must have the DOMAIN_RESOURCE[READ] permission on the specified domain or DOMAIN_RESOURCE[READ] permission on the specified environment or DOMAIN_RESOURCE[READ] permission on the specified organization operationId: getResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: resource in: path required: true schema: type: string responses: '200': description: Resource successfully fetched content: application/json: schema: $ref: '#/components/schemas/ServiceResource' '500': description: Internal server error put: tags: - domain summary: Update a resource description: User must have the DOMAIN_RESOURCE[UPDATE] permission on the specified domain or DOMAIN_RESOURCE[UPDATE] permission on the specified environment or DOMAIN_RESOURCE[UPDATE] permission on the specified organization operationId: updateResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: resource in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateServiceResource' required: true responses: '201': description: Resource successfully updated content: application/json: schema: $ref: '#/components/schemas/ServiceResource' '500': description: Internal server error delete: tags: - domain summary: Delete a resource description: User must have the DOMAIN_RESOURCE[DELETE] permission on the specified domain or DOMAIN_RESOURCE[DELETE] permission on the specified environment or DOMAIN_RESOURCE[DELETE] permission on the specified organization operationId: deleteResource parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: resource in: path required: true schema: type: string responses: '204': description: Resource successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/roles: get: tags: - domain summary: List registered roles for a security domain description: User must have the DOMAIN_ROLE[LIST] permission on the specified domain or DOMAIN_ROLE[LIST] permission on the specified environment or DOMAIN_ROLE[LIST] permission on the specified organization. Each returned role is filtered and contains only basic information such as id and name. operationId: findRoles parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 - name: q in: query schema: type: string responses: '200': description: List registered roles for a security domain content: application/json: schema: $ref: '#/components/schemas/RolePage' '500': description: Internal server error post: tags: - domain summary: Create a role description: User must have the DOMAIN_ROLE[CREATE] permission on the specified domain or DOMAIN_ROLE[CREATE] permission on the specified environment or DOMAIN_ROLE[CREATE] permission on the specified organization operationId: createRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewRole' required: true responses: '201': description: Role successfully created content: application/json: schema: $ref: '#/components/schemas/Role' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/roles/{role}: get: tags: - domain summary: Get a role description: User must have the DOMAIN_ROLE[READ] permission on the specified domain or DOMAIN_ROLE[READ] permission on the specified environment or DOMAIN_ROLE[READ] permission on the specified organization operationId: findRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: role in: path required: true schema: type: string responses: '200': description: Role successfully fetched content: application/json: schema: $ref: '#/components/schemas/RoleEntity' '500': description: Internal server error put: tags: - domain summary: Update a role description: User must have the DOMAIN_ROLE[UPDATE] permission on the specified domain or DOMAIN_ROLE[UPDATE] permission on the specified environment or DOMAIN_ROLE[UPDATE] permission on the specified organization operationId: updateRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: role in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRole' required: true responses: '201': description: Role successfully updated content: application/json: schema: $ref: '#/components/schemas/RoleEntity' '500': description: Internal server error delete: tags: - domain summary: Delete a role description: User must have the DOMAIN_ROLE[DELETE] permission on the specified domain or DOMAIN_ROLE[DELETE] permission on the specified environment or DOMAIN_ROLE[DELETE] permission on the specified organization operationId: deleteRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: role in: path required: true schema: type: string responses: '204': description: Role successfully deleted '400': description: Role is bind to existing users '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/scopes: get: tags: - domain summary: List scopes for a security domain description: User must have the DOMAIN_SCOPE[LIST] permission on the specified domain or DOMAIN_SCOPE[LIST] permission on the specified environment or DOMAIN_SCOPE[LIST] permission on the specified organization Each returned scope is filtered and contains only basic information such as id, key, name, description, isSystem and isDiscovery. operationId: listScopes parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: type: integer format: int32 default: 50 - name: q in: query schema: type: string responses: '200': description: List scopes for a security domain content: application/json: schema: $ref: '#/components/schemas/ScopePage' '500': description: Internal server error post: tags: - domain summary: Create a scope description: User must have the DOMAIN_SCOPE[CREATE] permission on the specified domain or DOMAIN_SCOPE[CREATE] permission on the specified environment or DOMAIN_SCOPE[CREATE] permission on the specified organization operationId: createScope parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewScope' required: true responses: '201': description: Scope successfully created content: application/json: schema: $ref: '#/components/schemas/Scope' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/scopes/{scope}: get: tags: - domain summary: Get a scope description: User must have the DOMAIN_SCOPE[READ] permission on the specified domain or DOMAIN_SCOPE[READ] permission on the specified environment or DOMAIN_SCOPE[READ] permission on the specified organization operationId: findScope parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: scope in: path required: true schema: type: string responses: '200': description: Scope content: application/json: schema: $ref: '#/components/schemas/Scope' '500': description: Internal server error put: tags: - domain summary: Update a scope description: User must have the DOMAIN_SCOPE[UPDATE] permission on the specified domain or DOMAIN_SCOPE[UPDATE] permission on the specified environment or DOMAIN_SCOPE[UPDATE] permission on the specified organization operationId: updateScope parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: scope in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateScope' required: true responses: '200': description: Scope successfully updated content: application/json: schema: $ref: '#/components/schemas/Scope' '500': description: Internal server error delete: tags: - domain summary: Delete a scope description: User must have the DOMAIN_SCOPE[DELETE] permission on the specified domain or DOMAIN_SCOPE[DELETE] permission on the specified environment or DOMAIN_SCOPE[DELETE] permission on the specified organization operationId: deleteScope parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: scope in: path required: true schema: type: string responses: '204': description: Scope successfully deleted '500': description: Internal server error patch: tags: - domain summary: Patch a scope description: User must have the DOMAIN_SCOPE[UPDATE] permission on the specified domain or DOMAIN_SCOPE[UPDATE] permission on the specified environment or DOMAIN_SCOPE[UPDATE] permission on the specified organization operationId: patchScope parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: scope in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchScope' required: true responses: '200': description: Scope successfully patched content: application/json: schema: $ref: '#/components/schemas/Scope' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/themes: get: tags: - domain summary: List themes on the specified security domain description: User must have the DOMAIN_THEME[LIST] permission on the specified domain or DOMAIN_THEME[LIST] permission on the specified environment or DOMAIN_THEME[LIST] permission on the specified organization operationId: listThemes parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string responses: '200': description: List of themes content: application/json: schema: type: array items: $ref: '#/components/schemas/ThemeEntity' '204': description: There is no themes on this domain '500': description: Internal server error post: tags: - domain summary: Create a theme on the specified security domain description: User must have the DOMAIN_THEME[CREATE] permission on the specified domain or DOMAIN_THEME[CREATE] permission on the specified environment or DOMAIN_THEME[CREATE] permission on the specified organization operationId: createTheme parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewTheme' required: true responses: '201': description: Theme successfully created content: application/json: schema: $ref: '#/components/schemas/ThemeEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/themes/{themeId}: get: tags: - domain summary: Get the theme linked to the specified security domain description: User must have the DOMAIN_THEME[READ] permission on the specified domain or DOMAIN_THEME[READ] permission on the specified environment or DOMAIN_THEME[READ] permission on the specified organization operationId: getTheme parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: themeId in: path required: true schema: type: string responses: '200': description: Get theme description content: application/json: schema: $ref: '#/components/schemas/ThemeEntity' '404': description: Theme doesn't exist '500': description: Internal server error put: tags: - domain summary: Update a theme on the specified security domain description: User must have the DOMAIN_THEME[UPDATE] permission on the specified domain or DOMAIN_THEME[UPDATE] permission on the specified environment or DOMAIN_THEME[UPDATE] permission on the specified organization operationId: updateTheme parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: themeId in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/ThemeEntity' required: true responses: '200': description: Theme successfully updated content: application/json: schema: $ref: '#/components/schemas/ThemeEntity' '404': description: Theme Not found '500': description: Internal server error delete: tags: - domain summary: Delete a theme on the specified security domain description: User must have the DOMAIN_THEME[DELETE] permission on the specified domain or DOMAIN_THEME[DELETE] permission on the specified environment or DOMAIN_THEME[DELETE] permission on the specified organization operationId: deleteTheme parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: themeId in: path required: true schema: type: string responses: '204': description: Theme successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users: get: tags: - domain summary: List users for a security domain description: User must have the DOMAIN_USER[LIST] permission on the specified domain or DOMAIN_USER[LIST] permission on the specified environment or DOMAIN_USER[LIST] permission on the specified organization. Each returned user is filtered and contains only basic information such as id and username and displayname. Last login and identity provider name will be also returned if current user has DOMAIN_USER[READ] permission on the domain, environment or organization. operationId: listUsers parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: q in: query schema: type: string - name: filter in: query schema: type: string - name: page in: query schema: type: integer format: int32 default: 0 - name: size in: query schema: maximum: 1000 minimum: 1 type: integer format: int32 default: 30 responses: '200': description: List users for a security domain content: application/json: schema: $ref: '#/components/schemas/UserPage' '500': description: Internal server error post: tags: - domain summary: Create a user on the specified security domain description: User must have the DOMAIN_USER[CREATE] permission on the specified domain or DOMAIN_USER[CREATE] permission on the specified environment or DOMAIN_USER[CREATE] permission on the specified organization operationId: createUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewUser' required: true responses: '201': description: User successfully created content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/bulk: post: tags: - domain summary: Create/update/delete multiple users on the specified security domain description: User must have the DOMAIN_USER[CREATE/UPDATE/DELETE] permission on the specified domain, the environment, or the organization operationId: bulkUserOperation parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/DomainUserBulkRequest' required: true responses: '200': description: Some users got created, inspect each result for details content: application/json: schema: $ref: '#/components/schemas/BulkResponse' '201': description: All users successfully created content: application/json: schema: $ref: '#/components/schemas/BulkResponse' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}: get: tags: - domain summary: Get a user description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: findUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: User successfully fetched content: application/json: schema: $ref: '#/components/schemas/UserEntity' '500': description: Internal server error put: tags: - domain summary: Update a user description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: updateUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateUser' required: true responses: '201': description: User successfully updated content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error delete: tags: - domain summary: Delete a user description: User must have the DOMAIN_USER[DELETE] permission on the specified domain or DOMAIN_USER[DELETE] permission on the specified environment or DOMAIN_USER[DELETE] permission on the specified organization operationId: deleteUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '204': description: User successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/audits: get: tags: - domain summary: Get a user audit logs description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserAuditLogs parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: type in: query schema: type: string - name: status in: query schema: type: string - name: from in: query schema: type: integer format: int64 - name: to in: query schema: type: integer format: int64 - name: size in: query schema: type: integer format: int32 default: 10 - name: page in: query schema: type: integer format: int32 default: 0 responses: '200': description: User audit logs successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/Audit' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/audits/{audit}: get: tags: - domain summary: Get a user audit log description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: getUserAuditLog parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: audit in: path required: true schema: type: string responses: '200': description: User audit log successfully fetched content: application/json: schema: $ref: '#/components/schemas/Audit' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials: get: tags: - domain summary: Get user certificate credentials description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserCertificateCredentials parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: User certificate credentials successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/CertificateCredential' '404': description: Domain not found '500': description: Internal server error post: tags: - domain summary: Enroll a certificate credential for a user description: User must have the DOMAIN_USER[CREATE] permission on the specified domain or DOMAIN_USER[CREATE] permission on the specified environment or DOMAIN_USER[CREATE] permission on the specified organization operationId: enrollUserCertificateCredential parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/NewCertificateCredential' required: true responses: '201': description: Certificate credential successfully enrolled content: application/json: schema: $ref: '#/components/schemas/CertificateCredential' '400': description: Invalid certificate or limit exceeded '404': description: Domain not found '409': description: Duplicate certificate '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/cert-credentials/{credential}: get: tags: - domain summary: Get a user certificate credential description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: getUserCertificateCredential parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: credential in: path required: true schema: type: string responses: '200': description: User certificate credential successfully fetched content: application/json: schema: $ref: '#/components/schemas/CertificateCredential' '404': description: Domain or certificate credential not found '500': description: Internal server error delete: tags: - domain summary: Revoke a user certificate credential description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: revokeUserCertificateCredential parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: credential in: path required: true schema: type: string responses: '204': description: Certificate credential successfully revoked '404': description: Domain or certificate credential not found '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents: get: tags: - domain summary: Get a user consents description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserConsents parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: clientId in: query schema: type: string responses: '200': description: User consents successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/ScopeApprovalEntity' '500': description: Internal server error delete: tags: - domain summary: Revoke user consents description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: revokeUserConsents parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: clientId in: query schema: type: string responses: '204': description: User consents successfully revoked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/consents/{consent}: get: tags: - domain summary: Get a user consent description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: getUserConsent parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: consent in: path required: true schema: type: string responses: '200': description: User consent successfully fetched content: application/json: schema: $ref: '#/components/schemas/ScopeApprovalEntity' '500': description: Internal server error delete: tags: - domain summary: Revoke a user consent description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: revokeUserConsent parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: consent in: path required: true schema: type: string responses: '204': description: User consent successfully revoked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/credentials: get: tags: - domain summary: Get a user credentials description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserCredentials parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: User credentials successfully fetched content: application/json: schema: $ref: '#/components/schemas/Credential' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/credentials/{credential}: get: tags: - domain summary: Get a user credential description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: getUserCredential parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: credential in: path required: true schema: type: string responses: '200': description: User credential successfully fetched content: application/json: schema: $ref: '#/components/schemas/Credential' '500': description: Internal server error delete: tags: - domain summary: Revoke a user credential description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: revokeUserCredential parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: credential in: path required: true schema: type: string responses: '204': description: User credential successfully revoked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/devices: get: tags: - domain summary: List users for a security domain description: 'User must have the DOMAIN_USER_DEVICES[LIST] permission on the specified domain or DOMAIN_USER_DEVICES[LIST] permission on the specified environment or DOMAIN_USER_DEVICES[LIST] permission on the specified organization. ' operationId: listUserDevices parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: List users for a security domain content: application/json: schema: type: array items: $ref: '#/components/schemas/User' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/devices/{device}: delete: tags: - domain summary: Delete a device description: User must have the DOMAIN_USER_DEVICE[DELETE] permission on the specified domain or DOMAIN_USER_DEVICE[DELETE] permission on the specified environment or DOMAIN_USER_DEVICE[DELETE] permission on the specified organization operationId: deleteUserDevice parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: device in: path required: true schema: type: string responses: '204': description: User successfully deleted '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/factors: get: tags: - domain summary: Get a user enrolled factors description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserEnrolledFactors parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: User enrolled factors successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/EnrolledFactorEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/factors/{factor}: delete: tags: - domain summary: Revoke user factor description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: deleteUserFactor parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: factor in: path required: true schema: type: string responses: '204': description: User factor successfully revoked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/identities: get: tags: - domain summary: Get a user linked identities description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserIdentities parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: User linked identities successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/UserIdentityEntity' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/identities/{identity}: delete: tags: - domain summary: Unlink user identity description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: unlinkUserIdentity parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: identity in: path required: true schema: type: string responses: '204': description: User identity successfully unlinked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/lock: post: tags: - domain summary: Lock a user description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: lockUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '204': description: User locked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/resetPassword: post: tags: - domain summary: Reset password description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: resetPassword parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: '*/*': schema: $ref: '#/components/schemas/PasswordValue' required: true responses: '200': description: Password reset '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/roles: get: tags: - domain summary: Get a user roles description: User must have the DOMAIN_USER[READ] permission on the specified domain or DOMAIN_USER[READ] permission on the specified environment or DOMAIN_USER[READ] permission on the specified organization operationId: listUserRoles parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: dynamic in: query schema: type: boolean default: false responses: '200': description: User roles successfully fetched content: application/json: schema: type: array items: $ref: '#/components/schemas/Role' '500': description: Internal server error post: tags: - domain summary: Assign roles to a user description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: assignRolesToUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: application/json: schema: type: array items: type: string required: true responses: '200': description: Roles successfully assigned content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/roles/{role}: delete: tags: - domain summary: Revoke role to a user description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: revokeUserRole parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string - name: role in: path required: true schema: type: string responses: '200': description: Roles successfully revoked content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/sendRegistrationConfirmation: post: tags: - domain summary: Send registration confirmation email description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: sendRegistrationConfirmation parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '200': description: Email sent '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/status: put: tags: - domain summary: Update a user status description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: updateUserStatus parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusEntity' required: true responses: '201': description: User status successfully updated content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/unlock: post: tags: - domain summary: Unlock a user description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: unlockUser parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string responses: '204': description: User unlocked '500': description: Internal server error /organizations/{organizationId}/environments/{environmentId}/domains/{domain}/users/{user}/username: patch: tags: - domain summary: Update a user username description: User must have the DOMAIN_USER[UPDATE] permission on the specified domain or DOMAIN_USER[UPDATE] permission on the specified environment or DOMAIN_USER[UPDATE] permission on the specified organization operationId: updateUsername parameters: - name: organizationId in: path required: true schema: type: string - name: environmentId in: path required: true schema: type: string - name: domain in: path required: true schema: type: string - name: user in: path required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/UsernameEntity' required: true responses: '201': description: User username successfully updated content: application/json: schema: $ref: '#/components/schemas/User' '500': description: Internal server error components: schemas: CertificateCredential: type: object properties: accessedAt: type: string format: date-time certificateExpiresAt: type: string format: date-time certificateIssuerDN: type: string certificatePem: type: string certificateSerialNumber: type: string certificateSubjectDN: type: string certificateThumbprint: type: string createdAt: type: string format: date-time id: type: string ipAddress: type: string metadata: type: object additionalProperties: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE updatedAt: type: string format: date-time userAgent: type: string userId: type: string username: type: string BaseJsonNode: type: object TokenClaim: type: object properties: claimName: type: string claimValue: type: string tokenType: type: string enum: - ACCESS_TOKEN - REFRESH_TOKEN - ID_TOKEN RememberDeviceSettings: type: object properties: active: type: boolean deviceIdentifierId: type: string expirationTimeSeconds: type: integer format: int64 skipChallengeWhenRememberDevice: type: boolean skipRememberDevice: type: boolean PreviewResponse: type: object properties: content: type: string template: type: string type: type: string enum: - EMAIL - FORM NewTheme: type: object properties: css: type: string faviconUrl: type: string logoUrl: type: string logoWidth: type: integer format: int32 primaryButtonColorHex: type: string primaryTextColorHex: type: string secondaryButtonColorHex: type: string secondaryTextColorHex: type: string PatchApplicationOAuthSettings: type: object properties: accessTokenValiditySeconds: type: integer format: int32 applicationType: type: string authorizationEncryptedResponseAlg: type: string authorizationEncryptedResponseEnc: type: string authorizationSignedResponseAlg: type: string clientIdIssuedAt: type: string format: date-time clientName: type: string clientSecretExpiresAt: type: string format: date-time clientUri: type: string contacts: type: array items: type: string defaultACRvalues: type: array items: type: string defaultMaxAge: type: integer format: int32 disableRefreshTokenRotation: type: boolean enhanceScopesWithUserPermissions: type: boolean forcePKCE: type: boolean forceS256CodeChallengeMethod: type: boolean grantTypes: type: array items: type: string idTokenEncryptedResponseAlg: type: string idTokenEncryptedResponseEnc: type: string idTokenSignedResponseAlg: type: string idTokenValiditySeconds: type: integer format: int32 initiateLoginUri: type: string jwks: $ref: '#/components/schemas/JWKSet' jwksUri: type: string logoUri: type: string policyUri: type: string postLogoutRedirectUris: type: array items: type: string redirectUris: type: array items: type: string refreshTokenValiditySeconds: type: integer format: int32 registrationAccessToken: type: string registrationClientUri: type: string requestObjectEncryptionAlg: type: string requestObjectEncryptionEnc: type: string requestObjectSigningAlg: type: string requestUris: type: array items: type: string requireAuthTime: type: boolean responseTypes: type: array items: type: string scopeSettings: type: array items: $ref: '#/components/schemas/ApplicationScopeSettings' sectorIdentifierUri: type: string silentReAuthentication: type: boolean singleSignOut: type: boolean softwareId: type: string softwareStatement: type: string softwareVersion: type: string subjectType: type: string tlsClientAuthSanDns: type: string tlsClientAuthSanEmail: type: string tlsClientAuthSanIp: type: string tlsClientAuthSanUri: type: string tlsClientAuthSubjectDn: type: string tlsClientCertificateBoundAccessTokens: type: boolean tokenCustomClaims: type: array items: $ref: '#/components/schemas/TokenClaim' tokenEndpointAuthMethod: type: string tokenEndpointAuthSigningAlg: type: string tokenExchangeOAuthSettings: $ref: '#/components/schemas/TokenExchangeOAuthSettings' tosUri: type: string userinfoCustomClaims: type: array items: $ref: '#/components/schemas/UserInfoClaim' userinfoEncryptedResponseAlg: type: string userinfoEncryptedResponseEnc: type: string userinfoSignedResponseAlg: type: string EnrollSettings: type: object properties: active: type: boolean enrollmentRule: type: string enrollmentSkipActive: type: boolean enrollmentSkipRule: type: string forceEnrollment: type: boolean skipTimeSeconds: type: integer format: int64 type: type: string enum: - OPTIONAL - REQUIRED - CONDITIONAL Role: type: object properties: assignableType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE createdAt: type: string format: date-time defaultRole: type: boolean description: type: string id: type: string internalOnly: type: boolean name: type: string oauthScopes: type: array items: type: string permissionAcls: type: object additionalProperties: uniqueItems: true type: array items: type: string enum: - CREATE - READ - LIST - UPDATE - DELETE referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE system: type: boolean updatedAt: type: string format: date-time CimdValidationRequest: required: - url type: object properties: url: type: string Certificate: type: object properties: value: type: string GroupPage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/Group' totalCount: type: integer format: int64 Flow: required: - name - type type: object properties: condition: type: string enabled: type: boolean id: type: string name: type: string post: type: array items: $ref: '#/components/schemas/Step' pre: type: array items: $ref: '#/components/schemas/Step' type: type: string enum: - ROOT - LOGIN_IDENTIFIER - LOGIN - CONNECT - CONSENT - REGISTER - RESET_PASSWORD - REGISTRATION_CONFIRMATION - TOKEN - WEBAUTHN_REGISTER - MFA_CHALLENGE - MFA_ENROLLMENT Email: type: object properties: client: type: string content: type: string createdAt: type: string format: date-time defaultTemplate: type: boolean enabled: type: boolean expiresAfter: type: integer format: int32 from: type: string fromName: type: string id: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE subject: type: string template: type: string updatedAt: type: string format: date-time NewScope: required: - description - key - name type: object properties: description: type: string discovery: type: boolean expiresIn: type: integer format: int32 iconUri: type: string key: type: string name: type: string parameterized: type: boolean NewRole: required: - name type: object properties: assignableType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE description: type: string name: type: string ApplicationIdentityProvider: type: object properties: identity: type: string priority: type: integer format: int32 selectionRule: type: string PatchRememberDeviceSettings: type: object properties: active: type: boolean deviceIdentifierId: type: string expirationTimeSeconds: type: integer format: int64 skipRememberDevice: type: boolean PatchClientRegistrationSettings: type: object properties: allowHttpSchemeRedirectUri: type: boolean allowLocalhostRedirectUri: type: boolean allowRedirectUriParamsExpressionLanguage: type: boolean allowWildCardRedirectUri: type: boolean allowedScopes: type: array items: type: string clientTemplateEnabled: type: boolean writeOnly: true defaultScopes: type: array items: type: string dynamicClientRegistrationEnabled: type: boolean writeOnly: true isAllowedScopesEnabled: type: boolean isClientTemplateEnabled: type: boolean isDynamicClientRegistrationEnabled: type: boolean isOpenDynamicClientRegistrationEnabled: type: boolean openDynamicClientRegistrationEnabled: type: boolean writeOnly: true StatusEntity: type: object properties: enabled: type: boolean Group: type: object properties: createdAt: type: string format: date-time description: type: string id: type: string members: type: array items: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE roles: type: array items: type: string updatedAt: type: string format: date-time UserId: type: object properties: externalId: type: string id: type: string source: type: string PatchSAMLSettings: type: object properties: certificate: type: string enabled: type: boolean entityId: type: string requiredPermissions: uniqueItems: true type: array items: type: string enum: - ORGANIZATION - ORGANIZATION_SETTINGS - ORGANIZATION_IDENTITY_PROVIDER - ORGANIZATION_AUDIT - ORGANIZATION_REPORTER - ORGANIZATION_SCOPE - ORGANIZATION_USER - ORGANIZATION_GROUP - ORGANIZATION_ROLE - ORGANIZATION_TAG - ORGANIZATION_ENTRYPOINT - ORGANIZATION_FORM - ORGANIZATION_MEMBER - ENVIRONMENT - DATA_PLANE - DOMAIN - DOMAIN_SETTINGS - DOMAIN_FORM - DOMAIN_EMAIL_TEMPLATE - DOMAIN_EXTENSION_POINT - DOMAIN_IDENTITY_PROVIDER - DOMAIN_AUTHORIZATION_ENGINE - DOMAIN_AUDIT - DOMAIN_CERTIFICATE - DOMAIN_USER - DOMAIN_USER_DEVICE - DOMAIN_GROUP - DOMAIN_ROLE - DOMAIN_SCIM - DOMAIN_SCOPE - DOMAIN_EXTENSION_GRANT - DOMAIN_OPENID - DOMAIN_SAML - DOMAIN_UMA - DOMAIN_UMA_SCOPE - DOMAIN_REPORTER - DOMAIN_MEMBER - DOMAIN_ANALYTICS - DOMAIN_FACTOR - DOMAIN_RESOURCE - DOMAIN_FLOW - DOMAIN_ALERT - DOMAIN_ALERT_NOTIFIER - DOMAIN_BOT_DETECTION - DOMAIN_DEVICE_IDENTIFIER - DOMAIN_AUTHDEVICE_NOTIFIER - DOMAIN_I18N_DICTIONARY - DOMAIN_THEME - APPLICATION - APPLICATION_SETTINGS - APPLICATION_IDENTITY_PROVIDER - APPLICATION_FORM - APPLICATION_EMAIL_TEMPLATE - APPLICATION_OPENID - APPLICATION_SAML - APPLICATION_CERTIFICATE - APPLICATION_MEMBER - APPLICATION_FACTOR - APPLICATION_RESOURCE - APPLICATION_ANALYTICS - APPLICATION_FLOW - LICENSE_NOTIFICATION - PROTECTED_RESOURCE - PROTECTED_RESOURCE_MEMBER - PROTECTED_RESOURCE_SETTINGS - PROTECTED_RESOURCE_OAUTH - PROTECTED_RESOURCE_CERTIFICATE - INSTALLATION CimdValidationResponse: type: object properties: hasInlineJwks: type: boolean metadata: $ref: '#/components/schemas/ClientMetadata' missing: $ref: '#/components/schemas/Missing' url: type: string UpdateUser: type: object properties: accountNonExpired: type: boolean accountNonLocked: type: boolean additionalInformation: type: object additionalProperties: type: object client: type: string createdAt: type: string format: date-time credentialsNonExpired: type: boolean displayName: type: string email: maxLength: 320 minLength: 0 type: string enabled: type: boolean externalId: type: string firstName: type: string forceResetPassword: type: boolean lastName: type: string loggedAt: type: string format: date-time loginsCount: type: integer format: int64 preRegistration: type: boolean preferredLanguage: type: string registrationCompleted: type: boolean source: type: string updatedAt: type: string format: date-time IdentityProvider: type: object properties: configuration: type: string createdAt: type: string format: date-time dataPlaneId: type: string domainWhitelist: type: array items: type: string external: type: boolean groupMapper: type: object additionalProperties: type: array items: type: string id: type: string mappers: type: object additionalProperties: type: string name: type: string passwordPolicy: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE roleMapper: type: object additionalProperties: type: array items: type: string system: type: boolean type: type: string updatedAt: type: string format: date-time PatchFactorSettings: type: object properties: applicationFactors: type: array items: $ref: '#/components/schemas/PatchApplicationFactorSettings' defaultFactorId: type: string JWK: type: object properties: alg: type: string keyOps: uniqueItems: true type: array items: type: string kid: type: string kty: type: string use: type: string x5c: uniqueItems: true type: array items: type: string x5t: type: string x5tS256: type: string x5u: type: string BulkCreateUser: required: - action - items type: object properties: action: type: string enum: - CREATE - UPDATE - DELETE failOnErrors: type: integer format: int32 items: minItems: 1 type: array items: $ref: '#/components/schemas/NewUser' CertificateEntity: type: object properties: applications: type: array items: $ref: '#/components/schemas/Application' createdAt: type: string format: date-time expiresAt: type: string format: date-time id: type: string identityProviders: type: array items: $ref: '#/components/schemas/IdentityProvider' name: type: string status: type: string enum: - VALID - WILL_EXPIRE - EXPIRED - RENEWED system: type: boolean type: type: string usage: type: array items: type: string NewIdentityProvider: required: - configuration - name - type type: object properties: configuration: type: string domainWhitelist: type: array items: type: string external: type: boolean id: type: string name: type: string type: type: string UserBindingCriterion: type: object properties: attribute: type: string expression: type: string SecurityProfileSettings: type: object properties: enableFapiBrazil: type: boolean enablePlainFapi: type: boolean ResetPasswordSettings: type: object properties: oldPasswordRequired: type: boolean tokenAge: type: integer format: int32 SAMLAssertionAttribute: required: - name - value type: object properties: name: type: string value: type: string UpdateServiceResource: required: - configuration - name - type type: object properties: configuration: type: string name: type: string type: minLength: 1 type: string AlertNotifier: type: object properties: configuration: type: string createdAt: type: string format: date-time enabled: type: boolean id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time NewBotDetection: required: - configuration - detectionType - name - type type: object properties: configuration: type: string detectionType: type: string id: type: string name: type: string type: type: string UMASettings: type: object properties: enabled: type: boolean PatchOIDCSettings: type: object properties: cibaSettings: $ref: '#/components/schemas/PatchCIBASettings' cimdSettings: $ref: '#/components/schemas/PatchCIMDSettings' clientRegistrationSettings: $ref: '#/components/schemas/PatchClientRegistrationSettings' postLogoutRedirectUris: type: array items: type: string redirectUriStrictMatching: type: boolean requestUris: type: array items: type: string requiredPermissions: uniqueItems: true type: array items: type: string enum: - ORGANIZATION - ORGANIZATION_SETTINGS - ORGANIZATION_IDENTITY_PROVIDER - ORGANIZATION_AUDIT - ORGANIZATION_REPORTER - ORGANIZATION_SCOPE - ORGANIZATION_USER - ORGANIZATION_GROUP - ORGANIZATION_ROLE - ORGANIZATION_TAG - ORGANIZATION_ENTRYPOINT - ORGANIZATION_FORM - ORGANIZATION_MEMBER - ENVIRONMENT - DATA_PLANE - DOMAIN - DOMAIN_SETTINGS - DOMAIN_FORM - DOMAIN_EMAIL_TEMPLATE - DOMAIN_EXTENSION_POINT - DOMAIN_IDENTITY_PROVIDER - DOMAIN_AUTHORIZATION_ENGINE - DOMAIN_AUDIT - DOMAIN_CERTIFICATE - DOMAIN_USER - DOMAIN_USER_DEVICE - DOMAIN_GROUP - DOMAIN_ROLE - DOMAIN_SCIM - DOMAIN_SCOPE - DOMAIN_EXTENSION_GRANT - DOMAIN_OPENID - DOMAIN_SAML - DOMAIN_UMA - DOMAIN_UMA_SCOPE - DOMAIN_REPORTER - DOMAIN_MEMBER - DOMAIN_ANALYTICS - DOMAIN_FACTOR - DOMAIN_RESOURCE - DOMAIN_FLOW - DOMAIN_ALERT - DOMAIN_ALERT_NOTIFIER - DOMAIN_BOT_DETECTION - DOMAIN_DEVICE_IDENTIFIER - DOMAIN_AUTHDEVICE_NOTIFIER - DOMAIN_I18N_DICTIONARY - DOMAIN_THEME - APPLICATION - APPLICATION_SETTINGS - APPLICATION_IDENTITY_PROVIDER - APPLICATION_FORM - APPLICATION_EMAIL_TEMPLATE - APPLICATION_OPENID - APPLICATION_SAML - APPLICATION_CERTIFICATE - APPLICATION_MEMBER - APPLICATION_FACTOR - APPLICATION_RESOURCE - APPLICATION_ANALYTICS - APPLICATION_FLOW - LICENSE_NOTIFICATION - PROTECTED_RESOURCE - PROTECTED_RESOURCE_MEMBER - PROTECTED_RESOURCE_SETTINGS - PROTECTED_RESOURCE_OAUTH - PROTECTED_RESOURCE_CERTIFICATE - INSTALLATION securityProfileSettings: $ref: '#/components/schemas/PatchSecurityProfileSettings' ApplicationSecretSettings: type: object properties: algorithm: type: string id: type: string FactorSettings: type: object properties: applicationFactors: type: array items: $ref: '#/components/schemas/ApplicationFactorSettings' defaultFactorId: type: string PatchSecurityProfileSettings: type: object properties: enableFapiBrazil: type: boolean enablePlainFapi: type: boolean ApplicationSAMLSettings: type: object properties: assertionAttributes: type: array items: $ref: '#/components/schemas/SAMLAssertionAttribute' assertionValiditySeconds: type: integer format: int32 attributeConsumeServiceUrl: type: string audiences: type: array items: type: string certificate: type: string dataEncryptionAlgorithm: type: string entityId: type: string includeAssertionConditions: type: boolean keyTransportEncryptionAlgorithm: type: string nameIdMapping: type: string notBeforeTimeSkewSeconds: type: integer format: int32 notOnOrAfterTimeSkewSeconds: type: integer format: int32 responseBinding: type: string singleLogoutServiceUrl: type: string wantAssertionsEncrypted: type: boolean wantAssertionsSigned: type: boolean wantResponseSigned: type: boolean ApplicationFactorSettings: type: object properties: id: type: string selectionRule: type: string NewReporter: required: - configuration - name - type type: object properties: configuration: type: string enabled: type: boolean id: type: string inherited: type: boolean name: type: string type: type: string Credential: type: object properties: aaguid: type: string accessedAt: type: string format: date-time attestationStatement: type: string attestationStatementFormat: type: string counter: type: integer format: int64 createdAt: type: string format: date-time credentialId: type: string deviceName: type: string id: type: string ipAddress: type: string lastCheckedAt: type: string format: date-time publicKey: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE updatedAt: type: string format: date-time userAgent: type: string userId: type: string username: type: string PatchDomain: type: object properties: accountSettings: $ref: '#/components/schemas/AccountSettings' alertEnabled: type: boolean certificateSettings: $ref: '#/components/schemas/CertificateSettings' corsSettings: $ref: '#/components/schemas/CorsSettings' dataPlaneId: type: string description: type: string enabled: type: boolean loginSettings: $ref: '#/components/schemas/LoginSettings' master: type: boolean name: type: string oidc: $ref: '#/components/schemas/PatchOIDCSettings' passwordSettings: $ref: '#/components/schemas/PatchPasswordSettings' path: type: string requiredPermissions: uniqueItems: true type: array items: type: string enum: - ORGANIZATION - ORGANIZATION_SETTINGS - ORGANIZATION_IDENTITY_PROVIDER - ORGANIZATION_AUDIT - ORGANIZATION_REPORTER - ORGANIZATION_SCOPE - ORGANIZATION_USER - ORGANIZATION_GROUP - ORGANIZATION_ROLE - ORGANIZATION_TAG - ORGANIZATION_ENTRYPOINT - ORGANIZATION_FORM - ORGANIZATION_MEMBER - ENVIRONMENT - DATA_PLANE - DOMAIN - DOMAIN_SETTINGS - DOMAIN_FORM - DOMAIN_EMAIL_TEMPLATE - DOMAIN_EXTENSION_POINT - DOMAIN_IDENTITY_PROVIDER - DOMAIN_AUTHORIZATION_ENGINE - DOMAIN_AUDIT - DOMAIN_CERTIFICATE - DOMAIN_USER - DOMAIN_USER_DEVICE - DOMAIN_GROUP - DOMAIN_ROLE - DOMAIN_SCIM - DOMAIN_SCOPE - DOMAIN_EXTENSION_GRANT - DOMAIN_OPENID - DOMAIN_SAML - DOMAIN_UMA - DOMAIN_UMA_SCOPE - DOMAIN_REPORTER - DOMAIN_MEMBER - DOMAIN_ANALYTICS - DOMAIN_FACTOR - DOMAIN_RESOURCE - DOMAIN_FLOW - DOMAIN_ALERT - DOMAIN_ALERT_NOTIFIER - DOMAIN_BOT_DETECTION - DOMAIN_DEVICE_IDENTIFIER - DOMAIN_AUTHDEVICE_NOTIFIER - DOMAIN_I18N_DICTIONARY - DOMAIN_THEME - APPLICATION - APPLICATION_SETTINGS - APPLICATION_IDENTITY_PROVIDER - APPLICATION_FORM - APPLICATION_EMAIL_TEMPLATE - APPLICATION_OPENID - APPLICATION_SAML - APPLICATION_CERTIFICATE - APPLICATION_MEMBER - APPLICATION_FACTOR - APPLICATION_RESOURCE - APPLICATION_ANALYTICS - APPLICATION_FLOW - LICENSE_NOTIFICATION - PROTECTED_RESOURCE - PROTECTED_RESOURCE_MEMBER - PROTECTED_RESOURCE_SETTINGS - PROTECTED_RESOURCE_OAUTH - PROTECTED_RESOURCE_CERTIFICATE - INSTALLATION saml: $ref: '#/components/schemas/PatchSAMLSettings' scim: $ref: '#/components/schemas/SCIMSettings' secretSettings: $ref: '#/components/schemas/SecretExpirationSettings' selfServiceAccountManagementSettings: $ref: '#/components/schemas/SelfServiceAccountManagementSettings' tags: uniqueItems: true type: array items: type: string tokenExchangeSettings: $ref: '#/components/schemas/TokenExchangeSettings' uma: $ref: '#/components/schemas/UMASettings' vhostMode: type: boolean vhosts: type: array items: $ref: '#/components/schemas/VirtualHost' webAuthnSettings: $ref: '#/components/schemas/WebAuthnSettings' UpdateGroup: required: - name type: object properties: description: type: string members: type: array items: type: string name: type: string roles: type: array items: type: string ClientSecret: type: object properties: createdAt: type: string format: date-time expiresAt: type: string format: date-time id: type: string name: type: string secret: type: string settingsId: type: string UpdateProtectedResourceFeature: required: - key - type type: object properties: description: type: string key: maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_-]+$ type: string type: type: string discriminator: propertyName: type Resource: type: object properties: clientId: type: string createdAt: type: string format: date-time description: type: string domain: type: string iconUri: type: string id: type: string name: type: string resourceScopes: type: array items: type: string type: type: string updatedAt: type: string format: date-time userId: type: string TokenExchangeSettings: type: object properties: allowDelegation: type: boolean allowImpersonation: type: boolean allowedActorTokenTypes: type: array items: type: string allowedRequestedTokenTypes: type: array items: type: string allowedSubjectTokenTypes: type: array items: type: string enabled: type: boolean maxDelegationDepth: type: integer format: int32 tokenExchangeOAuthSettings: $ref: '#/components/schemas/TokenExchangeOAuthSettings' trustedIssuers: type: array items: $ref: '#/components/schemas/TrustedIssuer' PatchApplicationSettings: type: object properties: account: $ref: '#/components/schemas/AccountSettings' advanced: $ref: '#/components/schemas/PatchApplicationAdvancedSettings' cookieSettings: $ref: '#/components/schemas/CookieSettings' login: $ref: '#/components/schemas/LoginSettings' mfa: $ref: '#/components/schemas/PatchMFASettings' oauth: $ref: '#/components/schemas/PatchApplicationOAuthSettings' passwordSettings: $ref: '#/components/schemas/PatchPasswordSettings' requiredPermissions: uniqueItems: true type: array items: type: string enum: - ORGANIZATION - ORGANIZATION_SETTINGS - ORGANIZATION_IDENTITY_PROVIDER - ORGANIZATION_AUDIT - ORGANIZATION_REPORTER - ORGANIZATION_SCOPE - ORGANIZATION_USER - ORGANIZATION_GROUP - ORGANIZATION_ROLE - ORGANIZATION_TAG - ORGANIZATION_ENTRYPOINT - ORGANIZATION_FORM - ORGANIZATION_MEMBER - ENVIRONMENT - DATA_PLANE - DOMAIN - DOMAIN_SETTINGS - DOMAIN_FORM - DOMAIN_EMAIL_TEMPLATE - DOMAIN_EXTENSION_POINT - DOMAIN_IDENTITY_PROVIDER - DOMAIN_AUTHORIZATION_ENGINE - DOMAIN_AUDIT - DOMAIN_CERTIFICATE - DOMAIN_USER - DOMAIN_USER_DEVICE - DOMAIN_GROUP - DOMAIN_ROLE - DOMAIN_SCIM - DOMAIN_SCOPE - DOMAIN_EXTENSION_GRANT - DOMAIN_OPENID - DOMAIN_SAML - DOMAIN_UMA - DOMAIN_UMA_SCOPE - DOMAIN_REPORTER - DOMAIN_MEMBER - DOMAIN_ANALYTICS - DOMAIN_FACTOR - DOMAIN_RESOURCE - DOMAIN_FLOW - DOMAIN_ALERT - DOMAIN_ALERT_NOTIFIER - DOMAIN_BOT_DETECTION - DOMAIN_DEVICE_IDENTIFIER - DOMAIN_AUTHDEVICE_NOTIFIER - DOMAIN_I18N_DICTIONARY - DOMAIN_THEME - APPLICATION - APPLICATION_SETTINGS - APPLICATION_IDENTITY_PROVIDER - APPLICATION_FORM - APPLICATION_EMAIL_TEMPLATE - APPLICATION_OPENID - APPLICATION_SAML - APPLICATION_CERTIFICATE - APPLICATION_MEMBER - APPLICATION_FACTOR - APPLICATION_RESOURCE - APPLICATION_ANALYTICS - APPLICATION_FLOW - LICENSE_NOTIFICATION - PROTECTED_RESOURCE - PROTECTED_RESOURCE_MEMBER - PROTECTED_RESOURCE_SETTINGS - PROTECTED_RESOURCE_OAUTH - PROTECTED_RESOURCE_CERTIFICATE - INSTALLATION riskAssessment: $ref: '#/components/schemas/RiskAssessmentSettings' saml: $ref: '#/components/schemas/PatchApplicationSAMLSettings' secretExpirationSettings: $ref: '#/components/schemas/SecretExpirationSettings' PasswordPolicy: type: object properties: createdAt: type: string format: date-time defaultPolicy: type: boolean excludePasswordsInDictionary: type: boolean excludeUserProfileInfoInPassword: type: boolean expiryDuration: type: integer format: int32 id: type: string includeNumbers: type: boolean includeSpecialCharacters: type: boolean lettersInMixedCase: type: boolean maxConsecutiveLetters: type: integer format: int32 maxLength: type: integer format: int32 minLength: type: integer format: int32 name: type: string oldPasswords: type: integer format: int32 passwordHistoryEnabled: type: boolean referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE regex: type: string updatedAt: type: string format: date-time Reporter: type: object properties: configuration: type: string createdAt: type: string format: date-time dataType: type: string enabled: type: boolean id: type: string inherited: type: boolean name: type: string reference: $ref: '#/components/schemas/Reference' system: type: boolean type: type: string updatedAt: type: string format: date-time UpdateFactor: required: - configuration - name - type type: object properties: configuration: type: string name: type: string type: minLength: 1 type: string NewGroup: required: - name type: object properties: description: type: string members: type: array items: type: string name: type: string FormField: type: object properties: key: type: string label: type: string type: type: string PatchScope: type: object properties: description: type: string discovery: type: boolean expiresIn: type: integer format: int32 iconUri: type: string name: type: string parameterized: type: boolean Form: type: object properties: assets: type: string client: type: string content: type: string createdAt: type: string format: date-time enabled: type: boolean id: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE template: type: string updatedAt: type: string format: date-time NewClientSecret: required: - name type: object properties: name: minLength: 1 type: string SessionSettings: type: object properties: persistent: type: boolean ApplicationOAuthSettings: type: object properties: accessTokenValiditySeconds: type: integer format: int32 applicationType: type: string authorizationEncryptedResponseAlg: type: string authorizationEncryptedResponseEnc: type: string authorizationSignedResponseAlg: type: string backchannelAuthRequestSignAlg: type: string backchannelClientNotificationEndpoint: type: string backchannelTokenDeliveryMode: type: string backchannelUserCodeParameter: type: boolean clientId: type: string clientIdIssuedAt: type: string format: date-time clientName: type: string clientSecret: type: string clientSecretExpiresAt: type: string format: date-time clientType: type: string clientUri: type: string contacts: type: array items: type: string defaultACRvalues: type: array items: type: string defaultMaxAge: type: integer format: int32 defaultScopes: type: array items: type: string disableRefreshTokenRotation: type: boolean enhanceScopesWithUserPermissions: type: boolean forcePKCE: type: boolean forceS256CodeChallengeMethod: type: boolean grantTypes: type: array items: type: string idTokenEncryptedResponseAlg: type: string idTokenEncryptedResponseEnc: type: string idTokenSignedResponseAlg: type: string idTokenValiditySeconds: type: integer format: int32 initiateLoginUri: type: string jwks: $ref: '#/components/schemas/JWKSet' jwksUri: type: string logoUri: type: string policyUri: type: string postLogoutRedirectUris: type: array items: type: string redirectUris: type: array items: type: string refreshTokenValiditySeconds: type: integer format: int32 registrationAccessToken: type: string registrationClientUri: type: string requestObjectEncryptionAlg: type: string requestObjectEncryptionEnc: type: string requestObjectSigningAlg: type: string requestUris: type: array items: type: string requireAuthTime: type: boolean requireParRequest: type: boolean responseTypes: type: array items: type: string scopeApprovals: type: object additionalProperties: type: integer format: int32 scopeSettings: type: array items: $ref: '#/components/schemas/ApplicationScopeSettings' scopes: type: array items: type: string sectorIdentifierUri: type: string silentReAuthentication: type: boolean singleSignOut: type: boolean softwareId: type: string softwareStatement: type: string softwareVersion: type: string subjectType: type: string tlsClientAuthSanDns: type: string tlsClientAuthSanEmail: type: string tlsClientAuthSanIp: type: string tlsClientAuthSanUri: type: string tlsClientAuthSubjectDn: type: string tlsClientCertificateBoundAccessTokens: type: boolean tokenCustomClaims: type: array items: $ref: '#/components/schemas/TokenClaim' tokenEndpointAuthMethod: type: string tokenEndpointAuthSigningAlg: type: string tokenExchangeOAuthSettings: $ref: '#/components/schemas/TokenExchangeOAuthSettings' tosUri: type: string userinfoCustomClaims: type: array items: $ref: '#/components/schemas/UserInfoClaim' userinfoEncryptedResponseAlg: type: string userinfoEncryptedResponseEnc: type: string userinfoSignedResponseAlg: type: string UpdateScope: required: - description - name type: object properties: description: type: string discovery: type: boolean expiresIn: type: integer format: int32 iconUri: type: string name: type: string parameterized: type: boolean UserPage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/User' totalCount: type: integer format: int64 SecretExpirationSettings: type: object properties: enabled: type: boolean expiryTimeSeconds: type: integer format: int64 UpdateAuthenticationDeviceNotifier: required: - configuration - name - type type: object properties: configuration: type: string name: type: string type: minLength: 1 type: string DomainPage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/Domain' totalCount: type: integer format: int64 NewPasswordPolicy: required: - name type: object properties: excludePasswordsInDictionary: type: boolean excludeUserProfileInfoInPassword: type: boolean expiryDuration: type: integer format: int32 includeNumbers: type: boolean includeSpecialCharacters: type: boolean lettersInMixedCase: type: boolean maxConsecutiveLetters: type: integer format: int32 maxLength: minimum: 0 type: integer format: int32 minLength: minimum: 0 type: integer format: int32 name: minLength: 1 type: string oldPasswords: type: integer format: int32 passwordHistoryEnabled: type: boolean FilteredIdentityProviderInfo: type: object properties: external: type: boolean id: type: string name: type: string passwordPolicy: type: string system: type: boolean type: type: string StepUpAuthenticationSettings: type: object properties: active: type: boolean stepUpAuthenticationRule: type: string FilteredApplication: type: object properties: clientId: type: string description: type: string enabled: type: boolean id: type: string name: type: string template: type: boolean type: type: string enum: - WEB - NATIVE - BROWSER - SERVICE - RESOURCE_SERVER updatedAt: type: string format: date-time UsernameEntity: required: - username type: object properties: username: minLength: 1 type: string NewApplication: required: - name - type type: object properties: clientId: type: string clientSecret: type: string description: type: string metadata: type: object additionalProperties: type: object name: type: string redirectUris: type: array items: type: string type: type: string enum: - WEB - NATIVE - BROWSER - SERVICE - RESOURCE_SERVER ScopeApprovalEntity: type: object properties: clientEntity: $ref: '#/components/schemas/ApplicationEntity' clientId: type: string createdAt: type: string format: date-time domain: type: string expiresAt: type: string format: date-time id: type: string scope: type: string scopeEntity: $ref: '#/components/schemas/ScopeEntity' status: type: string enum: - APPROVED - DENIED transactionId: type: string updatedAt: type: string format: date-time userId: $ref: '#/components/schemas/UserId' PatchApplicationFactorSettings: type: object properties: id: type: string selectionRule: type: string UpdateExtensionGrant: required: - configuration - name - type type: object properties: configuration: type: string createUser: type: boolean grantType: pattern: '[A-Za-z][A-Za-z0-9+\-.]*:(?://(?:(?:[A-Za-z0-9\-._~!$&''()*+,;=:]|%[0-9A-Fa-f]{2})*@)?(?:\[(?:(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}|::(?:[0-9A-Fa-f]{1,4}:){5}|(?:[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,1}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}|(?:(?:[0-9A-Fa-f]{1,4}:){0,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}|(?:(?:[0-9A-Fa-f]{1,4}:){0,3}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}:|(?:(?:[0-9A-Fa-f]{1,4}:){0,4}[0-9A-Fa-f]{1,4})?::)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){0,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,6}[0-9A-Fa-f]{1,4})?::)|[Vv][0-9A-Fa-f]+\.[A-Za-z0-9\-._~!$&''()*+,;=:]+)\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Za-z0-9\-._~!$&''()*+,;=]|%[0-9A-Fa-f]{2})*)(?::[0-9]*)?(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*|/(?:(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*)?|(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*|)(?:\?(?:[A-Za-z0-9\-._~!$&''()*+,;=:@/?]|%[0-9A-Fa-f]{2})*)?' type: string identityProvider: type: string name: type: string type: minLength: 1 type: string userExists: type: boolean ResourceListItem: type: object properties: metadata: type: object additionalProperties: type: object additionalProperties: type: object resources: type: array items: $ref: '#/components/schemas/ResourceEntity' AuthorizationEngine: type: object properties: configuration: type: string createdAt: type: string format: date-time id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time PatchEnrollSettings: type: object properties: active: type: boolean enrollmentRule: type: string enrollmentSkipActive: type: boolean enrollmentSkipRule: type: string forceEnrollment: type: boolean skipTimeSeconds: type: integer format: int64 type: type: string enum: - OPTIONAL - REQUIRED - CONDITIONAL PatchEnrollmentSettings: type: object properties: forceEnrollment: type: boolean skipTimeSeconds: type: integer format: int64 BulkUpdateUser: required: - action - items type: object properties: action: type: string enum: - CREATE - UPDATE - DELETE failOnErrors: type: integer format: int32 items: minItems: 1 type: array items: $ref: '#/components/schemas/UpdateUserWithId' Audit: type: object properties: accessPoint: $ref: '#/components/schemas/AuditAccessPoint' actor: $ref: '#/components/schemas/AuditEntity' id: type: string outcome: $ref: '#/components/schemas/AuditOutcome' reference: $ref: '#/components/schemas/Reference' referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE target: $ref: '#/components/schemas/AuditEntity' timestamp: type: string format: date-time writeOnly: true transactionId: type: string type: type: string PatchPasswordSettings: type: object properties: excludePasswordsInDictionary: type: boolean excludeUserProfileInfoInPassword: type: boolean expiryDuration: type: integer format: int32 includeNumbers: type: boolean includeSpecialCharacters: type: boolean inherited: type: boolean lettersInMixedCase: type: boolean maxConsecutiveLetters: type: integer format: int32 maxLength: type: integer format: int32 minLength: type: integer format: int32 oldPasswords: type: integer format: int32 passwordHistoryEnabled: type: boolean NewForm: required: - content - template type: object properties: assets: type: string content: type: string enabled: type: boolean template: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT RoleEntity: type: object properties: assignableType: type: string availablePermissions: type: array items: type: string createdAt: type: string format: date-time defaultRole: type: boolean description: type: string id: type: string name: type: string permissions: type: array items: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE system: type: boolean updatedAt: type: string format: date-time Membership: type: object properties: createdAt: type: string format: date-time domain: type: string fromRoleMapper: type: boolean id: type: string memberId: type: string memberType: type: string enum: - USER - GROUP referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE roleId: type: string updatedAt: type: string format: date-time NewMembership: required: - memberId - memberType - role type: object properties: memberId: type: string memberType: type: string enum: - USER - GROUP role: type: string ScopeEntity: type: object properties: description: type: string id: type: string key: type: string name: type: string ApplicationEntity: type: object properties: clientId: type: string id: type: string name: type: string UserIdentity: type: object properties: additionalInformation: type: object additionalProperties: type: object linkedAt: type: string format: date-time providerId: type: string userId: type: string username: type: string ProtectedResourceSecret: type: object properties: clientId: type: string clientSecret: type: string id: type: string name: type: string ChallengeSettings: type: object properties: active: type: boolean challengeRule: type: string type: type: string enum: - REQUIRED - CONDITIONAL - RISK_BASED BulkOperationResultObject: type: object properties: body: type: object errorDetails: type: object httpStatus: maximum: 599 minimum: 100 type: integer format: int32 index: type: integer format: int32 success: type: boolean UpdateProtectedResource: required: - name - resourceIdentifiers type: object properties: description: type: string features: type: array items: $ref: '#/components/schemas/UpdateProtectedResourceFeature' name: maxLength: 64 minLength: 1 pattern: ^[^\s].* type: string resourceIdentifiers: minItems: 1 type: array items: minLength: 1 type: string settings: $ref: '#/components/schemas/ApplicationSettings' ClientMetadata: type: object properties: application_type: type: string backchannel_authentication_request_signing_alg: type: string backchannel_client_notification_endpoint: type: string backchannel_token_delivery_mode: type: string backchannel_user_code_parameter: type: boolean client_id: type: string client_name: type: string client_uri: type: string contacts: type: array items: type: string grant_types: type: array items: type: string id_token_signed_response_alg: type: string jwks_uri: type: string logo_uri: type: string policy_uri: type: string post_logout_redirect_uris: type: array items: type: string redirect_uris: type: array items: type: string request_uris: type: array items: type: string response_types: type: array items: type: string scope: type: string sector_identifier_uri: type: string software_id: type: string software_statement: type: string software_version: type: string subject_type: type: string tls_client_auth_san_dns: type: string tls_client_auth_san_email: type: string tls_client_auth_san_ip: type: string tls_client_auth_san_uri: type: string tls_client_auth_subject_dn: type: string tls_client_certificate_bound_access_tokens: type: boolean token_endpoint_auth_method: type: string tos_uri: type: string additionalProperties: true description: OAuth 2.0 client metadata as defined in the IANA OAuth Parameters registry (https://www.iana.org/assignments/oauth-parameters/oauth-parameters.xhtml#client-metadata). PatchAlertTrigger: required: - type type: object properties: alertNotifiers: type: array items: type: string enabled: type: boolean type: type: string enum: - TOO_MANY_LOGIN_FAILURES - RISK_ASSESSMENT EnrolledFactorSecurity: type: object properties: additionalData: type: object additionalProperties: type: object type: type: string value: type: string ServiceResource: type: object properties: configuration: type: string createdAt: type: string format: date-time id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time ExtensionGrant: type: object properties: configuration: type: string createUser: type: boolean createdAt: type: string format: date-time domain: type: string grantType: type: string id: type: string identityProvider: type: string name: type: string type: type: string updatedAt: type: string format: date-time userExists: type: boolean Missing: type: object properties: clientId: type: boolean clientName: type: boolean PasswordValue: required: - password type: object properties: password: type: string ModifiedCertificateEntity: type: object properties: configuration: type: string createdAt: type: string format: date-time domain: type: string expiresAt: type: string format: date-time id: type: string metadata: type: object additionalProperties: type: object name: type: string system: type: boolean type: type: string updatedAt: type: string format: date-time Entrypoint: type: object properties: createdAt: type: string format: date-time defaultEntrypoint: type: boolean description: type: string id: type: string name: type: string organizationId: type: string tags: type: array items: type: string updatedAt: type: string format: date-time url: type: string FlowEntity: type: object properties: condition: type: string createdAt: type: string format: date-time enabled: type: boolean icon: type: string id: type: string name: type: string post: type: array items: $ref: '#/components/schemas/Step' pre: type: array items: $ref: '#/components/schemas/Step' type: type: string enum: - ROOT - LOGIN_IDENTIFIER - LOGIN - CONNECT - CONSENT - REGISTER - RESET_PASSWORD - REGISTRATION_CONFIRMATION - TOKEN - WEBAUTHN_REGISTER - MFA_CHALLENGE - MFA_ENROLLMENT updatedAt: type: string format: date-time AccessPolicyListItem: type: object properties: createdAt: type: string format: date-time description: type: string id: type: string name: type: string updatedAt: type: string format: date-time AssignPasswordPolicy: type: object properties: passwordPolicy: type: string UpdateForm: type: object properties: assets: type: string content: type: string enabled: type: boolean LoginSettings: type: object properties: certificateBasedAuthEnabled: type: boolean certificateBasedAuthUrl: type: string enforcePasswordPolicyEnabled: type: boolean forgotPasswordEnabled: type: boolean hideForm: type: boolean identifierFirstEnabled: type: boolean inherited: type: boolean magicLinkAuthEnabled: type: boolean passwordlessDeviceNamingEnabled: type: boolean passwordlessEnabled: type: boolean passwordlessEnforcePasswordEnabled: type: boolean passwordlessEnforcePasswordMaxAge: type: integer format: int32 passwordlessRememberDeviceEnabled: type: boolean registerEnabled: type: boolean rememberMeEnabled: type: boolean resetPasswordOnExpiration: type: boolean NewFactor: required: - configuration - factorType - name - type type: object properties: configuration: type: string factorType: type: string id: type: string name: type: string type: type: string BotDetection: type: object properties: configuration: type: string createdAt: type: string format: date-time detectionType: type: string id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time MembershipListItem: type: object properties: memberships: type: array items: $ref: '#/components/schemas/Membership' metadata: type: object additionalProperties: type: object additionalProperties: type: object AccessPolicy: type: object properties: condition: type: string createdAt: type: string format: date-time description: type: string domain: type: string enabled: type: boolean id: type: string name: type: string order: type: integer format: int32 resource: type: string type: type: string enum: - GROOVY updatedAt: type: string format: date-time I18nDictionary: type: object properties: createdAt: type: string format: date-time entries: type: object additionalProperties: type: string id: type: string locale: type: string name: type: string reference: $ref: '#/components/schemas/Reference' referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE updatedAt: type: string format: date-time SAMLSettings: type: object properties: certificate: type: string enabled: type: boolean entityId: type: string NewProtectedResourceFeature: required: - key - type type: object properties: description: type: string key: maxLength: 64 minLength: 1 pattern: ^[a-zA-Z0-9_-]+$ type: string type: type: string discriminator: propertyName: type SCIMSettings: type: object properties: enabled: type: boolean idpSelectionEnabled: type: boolean idpSelectionRule: type: string NewCimdApplication: required: - cimdUrl - name - type type: object properties: cimdUrl: type: string clientName: type: string description: type: string name: type: string type: type: string enum: - WEB - NATIVE - BROWSER - SERVICE - RESOURCE_SERVER CIBASettings: type: object properties: authReqExpiry: type: integer format: int32 bindingMessageLength: type: integer format: int32 deviceNotifiers: type: array items: $ref: '#/components/schemas/CIBASettingNotifier' enabled: type: boolean tokenReqInterval: type: integer format: int32 PasswordPolicyEntity: type: object properties: id: type: string idpsNames: type: array items: type: string isDefault: type: boolean name: type: string NewAuthorizationEngine: required: - configuration - name - type type: object properties: configuration: type: string id: type: string name: type: string type: type: string User: type: object properties: accountLockedAt: type: string format: date-time accountLockedUntil: type: string format: date-time accountNonExpired: type: boolean accountNonLocked: type: boolean additionalInformation: type: object additionalProperties: type: object address: type: object additionalProperties: type: object addresses: type: array items: $ref: '#/components/schemas/Address' birthdate: type: string client: type: string createdAt: type: string format: date-time credentialsNonExpired: type: boolean disabled: type: boolean displayName: type: string dynamicGroups: type: array items: type: string dynamicRoles: type: array items: type: string email: type: string emails: type: array items: $ref: '#/components/schemas/Attribute' enabled: type: boolean entitlements: type: array items: type: string externalId: type: string factors: type: array items: $ref: '#/components/schemas/EnrolledFactor' firstName: type: string forceResetPassword: type: boolean fullId: $ref: '#/components/schemas/UserId' groups: type: array items: type: string id: type: string identities: type: array items: $ref: '#/components/schemas/UserIdentity' identitiesAsMap: type: object additionalProperties: type: object ims: type: array items: $ref: '#/components/schemas/Attribute' inactive: type: boolean indefinitelyLocked: type: boolean internal: type: boolean lastIdentityInformation: type: object additionalProperties: type: object lastIdentityUsed: type: string lastLoginWithCredentials: type: string format: date-time lastLogoutAt: type: string format: date-time lastName: type: string lastPasswordReset: type: string format: date-time lastUsernameReset: type: string format: date-time locale: type: string loggedAt: type: string format: date-time loginsCount: type: integer format: int64 mfaEnrollmentSkippedAt: type: string format: date-time middleName: type: string newsletter: type: boolean nickName: type: string password: type: string phoneNumber: type: string phoneNumbers: type: array items: $ref: '#/components/schemas/Attribute' photos: type: array items: $ref: '#/components/schemas/Attribute' picture: type: string preRegistration: type: boolean preferredLanguage: type: string profile: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE registrationAccessToken: type: string registrationCompleted: type: boolean registrationUserUri: type: string roles: type: array items: type: string rolesPermissions: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' serviceAccount: type: boolean source: type: string temporarilyLocked: type: boolean title: type: string type: type: string updatedAt: type: string format: date-time username: type: string website: type: string x509Certificates: type: array items: $ref: '#/components/schemas/Certificate' zoneInfo: type: string NewServiceResource: required: - configuration - name - type type: object properties: configuration: type: string id: type: string name: type: string type: type: string Step: type: object properties: condition: type: string configuration: type: string description: type: string enabled: type: boolean name: type: string policy: type: string NewDictionary: required: - locale - name type: object properties: locale: minLength: 1 type: string name: minLength: 1 type: string PatchProtectedResource: type: object properties: certificate: type: string description: type: string features: type: array items: $ref: '#/components/schemas/UpdateProtectedResourceFeature' name: maxLength: 64 minLength: 1 pattern: ^[^\s].* type: string resourceIdentifiers: type: array items: type: string secretSettings: type: array items: $ref: '#/components/schemas/ApplicationSecretSettings' settings: $ref: '#/components/schemas/ApplicationSettings' EnrolledFactorEntity: type: object properties: createdAt: type: string format: date-time id: type: string name: type: string type: type: string updatedAt: type: string format: date-time UpdateBotDetection: required: - configuration - name - type type: object properties: configuration: type: string name: type: string type: minLength: 1 type: string AuditEntity: type: object properties: alternativeId: type: string attributes: type: object additionalProperties: type: object displayName: type: string id: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string EnrolledFactor: type: object properties: appId: type: string channel: $ref: '#/components/schemas/EnrolledFactorChannel' createdAt: type: string format: date-time factorId: type: string primary: type: boolean security: $ref: '#/components/schemas/EnrolledFactorSecurity' status: type: string enum: - PENDING_ACTIVATION - ACTIVATED - REVOKED - 'NULL' updatedAt: type: string format: date-time UpdateUserWithId: type: object properties: accountNonExpired: type: boolean accountNonLocked: type: boolean additionalInformation: type: object additionalProperties: type: object client: type: string createdAt: type: string format: date-time credentialsNonExpired: type: boolean displayName: type: string email: maxLength: 320 minLength: 0 type: string enabled: type: boolean externalId: type: string firstName: type: string forceResetPassword: type: boolean id: type: string lastName: type: string loggedAt: type: string format: date-time loginsCount: type: integer format: int64 preRegistration: type: boolean preferredLanguage: type: string registrationCompleted: type: boolean source: type: string updatedAt: type: string format: date-time WebAuthnSettings: type: object properties: attestationConveyancePreference: type: string enum: - NONE - INDIRECT - DIRECT authenticatorAttachment: type: string enum: - CROSS_PLATFORM - PLATFORM certificates: type: object additionalProperties: type: object enforceAuthenticatorIntegrity: type: boolean enforceAuthenticatorIntegrityMaxAge: type: integer format: int32 forceRegistration: type: boolean origin: type: string relyingPartyId: type: string relyingPartyName: type: string requireResidentKey: type: boolean userVerification: type: string enum: - REQUIRED - PREFERRED - DISCOURAGED NewDomain: required: - dataPlaneId - name type: object properties: dataPlaneId: type: string description: type: string name: type: string PasswordSettings: type: object properties: excludePasswordsInDictionary: type: boolean excludeUserProfileInfoInPassword: type: boolean expiryDuration: type: integer format: int32 includeNumbers: type: boolean includeSpecialCharacters: type: boolean inherited: type: boolean lettersInMixedCase: type: boolean maxConsecutiveLetters: type: integer format: int32 maxLength: type: integer format: int32 minLength: type: integer format: int32 oldPasswords: type: integer format: int32 passwordHistoryEnabled: type: boolean PatchApplicationAdvancedSettings: type: object properties: flowsInherited: type: boolean skipConsent: type: boolean Attribute: type: object properties: primary: type: boolean type: type: string value: type: string ProtectedResourcePage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/ProtectedResourcePrimaryData' totalCount: type: integer format: int64 PatchApplicationType: required: - type type: object properties: type: type: string enum: - WEB - NATIVE - BROWSER - SERVICE - RESOURCE_SERVER ApplicationSettings: type: object properties: account: $ref: '#/components/schemas/AccountSettings' advanced: $ref: '#/components/schemas/ApplicationAdvancedSettings' cookieSettings: $ref: '#/components/schemas/CookieSettings' login: $ref: '#/components/schemas/LoginSettings' mfa: $ref: '#/components/schemas/MFASettings' oauth: $ref: '#/components/schemas/ApplicationOAuthSettings' passwordSettings: $ref: '#/components/schemas/PasswordSettings' riskAssessment: $ref: '#/components/schemas/RiskAssessmentSettings' saml: $ref: '#/components/schemas/ApplicationSAMLSettings' secretExpirationSettings: $ref: '#/components/schemas/SecretExpirationSettings' RolePage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/Role' totalCount: type: integer format: int64 Domain: type: object properties: accountSettings: $ref: '#/components/schemas/AccountSettings' alertEnabled: type: boolean certificateSettings: $ref: '#/components/schemas/CertificateSettings' corsSettings: $ref: '#/components/schemas/CorsSettings' createdAt: type: string format: date-time dataPlaneId: type: string description: type: string dynamicClientRegistrationEnabled: type: boolean dynamicClientRegistrationTemplateEnabled: type: boolean enabled: type: boolean hrid: type: string id: type: string identities: uniqueItems: true type: array items: type: string loginSettings: $ref: '#/components/schemas/LoginSettings' master: type: boolean name: type: string oidc: $ref: '#/components/schemas/OIDCSettings' openDynamicClientRegistrationEnabled: type: boolean passwordSettings: $ref: '#/components/schemas/PasswordSettings' path: type: string redirectUriExpressionLanguageEnabled: type: boolean redirectUriLocalhostAllowed: type: boolean redirectUriStrictMatching: type: boolean redirectUriUnsecuredHttpSchemeAllowed: type: boolean redirectUriWildcardAllowed: type: boolean referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE saml: $ref: '#/components/schemas/SAMLSettings' scim: $ref: '#/components/schemas/SCIMSettings' secretExpirationSettings: $ref: '#/components/schemas/SecretExpirationSettings' selfServiceAccountManagementSettings: $ref: '#/components/schemas/SelfServiceAccountManagementSettings' tags: uniqueItems: true type: array items: type: string tokenExchangeSettings: $ref: '#/components/schemas/TokenExchangeSettings' uma: $ref: '#/components/schemas/UMASettings' updatedAt: type: string format: date-time version: type: string enum: - V1_0 - V2_0 vhostMode: type: boolean vhosts: type: array items: $ref: '#/components/schemas/VirtualHost' webAuthnSettings: $ref: '#/components/schemas/WebAuthnSettings' NewProtectedResource: required: - name - resourceIdentifiers - type type: object properties: clientId: type: string clientSecret: type: string description: type: string features: type: array items: $ref: '#/components/schemas/NewProtectedResourceFeature' name: maxLength: 64 minLength: 1 pattern: ^[^\s].* type: string resourceIdentifiers: minItems: 1 type: array items: minLength: 1 type: string settings: $ref: '#/components/schemas/ApplicationSettings' type: minLength: 1 pattern: ^MCP_SERVER$ type: string UpdateDeviceIdentifier: required: - configuration - name - type type: object properties: configuration: type: string name: type: string type: minLength: 1 type: string AssessmentSettings: type: object properties: enabled: type: boolean thresholds: type: object additionalProperties: type: number format: double UpdatePasswordPolicy: required: - name type: object properties: defaultPolicy: type: boolean excludePasswordsInDictionary: type: boolean excludeUserProfileInfoInPassword: type: boolean expiryDuration: type: integer format: int32 includeNumbers: type: boolean includeSpecialCharacters: type: boolean lettersInMixedCase: type: boolean maxConsecutiveLetters: type: integer format: int32 maxLength: minimum: 0 type: integer format: int32 minLength: minimum: 0 type: integer format: int32 name: minLength: 1 type: string oldPasswords: type: integer format: int32 passwordHistoryEnabled: type: boolean DomainUserBulkRequest: required: - action - items type: object properties: action: type: string enum: - CREATE - UPDATE - DELETE failOnErrors: type: integer format: int32 items: minItems: 1 type: array items: $ref: '#/components/schemas/BaseJsonNode' discriminator: propertyName: action mapping: CREATE: '#/components/schemas/BulkCreateUser' UPDATE: '#/components/schemas/BulkUpdateUser' DELETE: '#/components/schemas/BulkDeleteUser' oneOf: - $ref: '#/components/schemas/BulkCreateUser' - $ref: '#/components/schemas/BulkUpdateUser' - $ref: '#/components/schemas/BulkDeleteUser' ApplicationScopeSettings: type: object properties: defaultScope: type: boolean scope: type: string scopeApproval: type: integer format: int32 NewAlertNotifier: required: - configuration - type type: object properties: configuration: type: string enabled: type: boolean name: type: string writeOnly: true type: minLength: 1 type: string NewDeviceIdentifier: required: - configuration - name - type type: object properties: configuration: type: string id: type: string name: type: string type: type: string CertificateKey: type: object properties: fmt: type: string metadata: type: object additionalProperties: type: object payload: type: string JWKSet: type: object properties: keys: type: array items: $ref: '#/components/schemas/JWK' PatchAlertNotifier: type: object properties: configuration: type: string enabled: type: boolean name: type: string OIDCSettings: type: object properties: cibaSettings: $ref: '#/components/schemas/CIBASettings' cimdSettings: $ref: '#/components/schemas/CIMDSettings' clientRegistrationSettings: $ref: '#/components/schemas/ClientRegistrationSettings' postLogoutRedirectUris: type: array items: type: string redirectUriStrictMatching: type: boolean requestUris: type: array items: type: string securityProfileSettings: $ref: '#/components/schemas/SecurityProfileSettings' UserInfoClaim: type: object properties: claimName: type: string claimValue: type: string UpdateAuthorizationEngine: required: - configuration - name type: object properties: configuration: type: string name: type: string type: type: string CorsSettings: type: object properties: allowCredentials: type: boolean allowedHeaders: uniqueItems: true type: array items: type: string allowedMethods: uniqueItems: true type: array items: type: string allowedOrigins: uniqueItems: true type: array items: type: string enabled: type: boolean maxAge: type: integer format: int32 UpdateReporter: required: - configuration - name - type type: object properties: configuration: type: string enabled: type: boolean inherited: type: boolean name: type: string type: minLength: 1 type: string CIBASettingNotifier: type: object properties: id: type: string ApplicationAdvancedSettings: type: object properties: flowsInherited: type: boolean skipConsent: type: boolean TrustedIssuer: type: object properties: certificate: type: string issuer: type: string jwksUri: type: string keyResolutionMethod: type: string enum: - JWKS_URL - PEM scopeMappings: type: object additionalProperties: type: string userBindingCriteria: type: array items: $ref: '#/components/schemas/UserBindingCriterion' userBindingEnabled: type: boolean BulkDeleteUser: required: - action - items type: object properties: action: type: string enum: - CREATE - UPDATE - DELETE failOnErrors: type: integer format: int32 items: minItems: 1 type: array items: type: string UserEntity: type: object properties: accountLockedAt: type: string format: date-time accountLockedUntil: type: string format: date-time accountNonExpired: type: boolean accountNonLocked: type: boolean additionalInformation: type: object additionalProperties: type: object address: type: object additionalProperties: type: object addresses: type: array items: $ref: '#/components/schemas/Address' applicationEntity: $ref: '#/components/schemas/ApplicationEntity' birthdate: type: string client: type: string createdAt: type: string format: date-time credentialsNonExpired: type: boolean disabled: type: boolean displayName: type: string dynamicGroups: type: array items: type: string dynamicRoles: type: array items: type: string email: type: string emails: type: array items: $ref: '#/components/schemas/Attribute' enabled: type: boolean entitlements: type: array items: type: string externalId: type: string factors: type: array items: $ref: '#/components/schemas/EnrolledFactor' firstName: type: string forceResetPassword: type: boolean fullId: $ref: '#/components/schemas/UserId' groups: type: array items: type: string id: type: string identities: type: array items: $ref: '#/components/schemas/UserIdentity' identitiesAsMap: type: object additionalProperties: type: object ims: type: array items: $ref: '#/components/schemas/Attribute' inactive: type: boolean indefinitelyLocked: type: boolean internal: type: boolean lastIdentityInformation: type: object additionalProperties: type: object lastIdentityUsed: type: string lastLoginWithCredentials: type: string format: date-time lastLogoutAt: type: string format: date-time lastName: type: string lastPasswordReset: type: string format: date-time lastUsernameReset: type: string format: date-time locale: type: string loggedAt: type: string format: date-time loginsCount: type: integer format: int64 mfaEnrollmentSkippedAt: type: string format: date-time middleName: type: string newsletter: type: boolean nickName: type: string password: type: string phoneNumber: type: string phoneNumbers: type: array items: $ref: '#/components/schemas/Attribute' photos: type: array items: $ref: '#/components/schemas/Attribute' picture: type: string preRegistration: type: boolean preferredLanguage: type: string profile: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE registrationAccessToken: type: string registrationCompleted: type: boolean registrationUserUri: type: string roles: type: array items: type: string rolesPermissions: uniqueItems: true type: array items: $ref: '#/components/schemas/Role' serviceAccount: type: boolean source: type: string sourceId: type: string temporarilyLocked: type: boolean title: type: string type: type: string updatedAt: type: string format: date-time username: type: string website: type: string x509Certificates: type: array items: $ref: '#/components/schemas/Certificate' zoneInfo: type: string Address: type: object properties: country: type: string formatted: type: string locality: type: string postalCode: type: string primary: type: boolean region: type: string streetAddress: type: string type: type: string UpdateRole: required: - name type: object properties: description: type: string name: type: string oauthScopes: type: array items: type: string permissions: type: array items: type: string NewEmail: required: - content - expiresAfter - from - subject - template type: object properties: content: type: string enabled: type: boolean expiresAfter: minimum: 1 type: integer format: int32 from: type: string fromName: type: string subject: type: string template: type: string enum: - LOGIN - REGISTRATION - REGISTRATION_CONFIRMATION - REGISTRATION_VERIFY - FORGOT_PASSWORD - RESET_PASSWORD - OAUTH2_USER_CONSENT - MFA_ENROLL - MFA_CHALLENGE - MFA_CHALLENGE_ALTERNATIVES - MFA_RECOVERY_CODE - BLOCKED_ACCOUNT - COMPLETE_PROFILE - WEBAUTHN_REGISTER - WEBAUTHN_REGISTER_SUCCESS - WEBAUTHN_LOGIN - CBA_LOGIN - MAGIC_LINK_LOGIN - MAGIC_LINK - IDENTIFIER_FIRST_LOGIN - ERROR - CERTIFICATE_EXPIRATION - CLIENT_SECRET_EXPIRATION - VERIFY_ATTEMPT CertificateSettings: type: object properties: fallbackCertificate: type: string UpdateEmail: required: - content - expiresAfter - from - subject type: object properties: content: type: string enabled: type: boolean expiresAfter: minimum: 1 type: integer format: int32 from: type: string fromName: type: string subject: type: string AuditOutcome: type: object properties: message: type: string status: type: string enum: - SUCCESS - FAILURE PatchMFASettings: type: object properties: adaptiveAuthenticationRule: type: string challenge: $ref: '#/components/schemas/PatchChallengeSettings' enroll: $ref: '#/components/schemas/PatchEnrollSettings' enrollment: $ref: '#/components/schemas/PatchEnrollmentSettings' factor: $ref: '#/components/schemas/PatchFactorSettings' loginRule: type: string rememberDevice: $ref: '#/components/schemas/PatchRememberDeviceSettings' stepUpAuthentication: $ref: '#/components/schemas/PatchStepUpAuthentication' stepUpAuthenticationRule: type: string PatchStepUpAuthentication: type: object properties: active: type: boolean stepUpAuthenticationRule: type: string ProtectedResourcePrimaryData: type: object properties: certificate: type: string clientId: type: string description: type: string features: type: array items: $ref: '#/components/schemas/ProtectedResourceFeature' id: type: string name: type: string resourceIdentifiers: type: array items: type: string secretSettings: type: array items: $ref: '#/components/schemas/ApplicationSecretSettings' settings: $ref: '#/components/schemas/ApplicationSettings' type: type: string enum: - MCP_SERVER updatedAt: type: string format: date-time CIMDSettings: type: object properties: allowPrivateIpAddress: type: boolean allowUnsecuredHttpUri: type: boolean allowedDomains: type: array items: type: string cacheMaxEntries: type: integer format: int32 cacheTtlSeconds: type: integer format: int32 enabled: type: boolean fetchTimeoutMs: type: integer format: int32 maxResponseSizeKb: type: integer format: int32 revokeOnDocumentChange: type: boolean templateId: type: string UserIdentityEntity: type: object properties: additionalInformation: type: object additionalProperties: type: object linkedAt: type: string format: date-time providerId: type: string providerName: type: string userId: type: string username: type: string NewCertificate: required: - configuration - name - type type: object properties: configuration: type: string name: minLength: 1 type: string type: minLength: 1 type: string ResourceEntity: type: object properties: clientId: type: string createdAt: type: string format: date-time description: type: string domain: type: string iconUri: type: string id: type: string name: type: string policies: type: integer format: int64 resourceScopes: type: array items: type: string type: type: string updatedAt: type: string format: date-time userDisplayName: type: string userId: type: string Reference: type: object properties: id: type: string type: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE AccountSettings: type: object properties: accountBlockedDuration: type: integer format: int32 autoLoginAfterRegistration: type: boolean autoLoginAfterResetPassword: type: boolean botDetectionPlugin: type: string completeRegistrationWhenResetPassword: type: boolean defaultIdentityProviderForRegistration: type: string deletePasswordlessDevicesAfterResetPassword: type: boolean dynamicUserRegistration: type: boolean inherited: type: boolean loginAttemptsDetectionEnabled: type: boolean loginAttemptsResetTime: type: integer format: int32 maxLoginAttempts: type: integer format: int32 mfaChallengeAttemptsDetectionEnabled: type: boolean mfaChallengeAttemptsResetTime: type: integer format: int32 mfaChallengeMaxAttempts: type: integer format: int32 mfaChallengeSendVerifyAlertEmail: type: boolean redirectUriAfterRegistration: type: string redirectUriAfterResetPassword: type: string rememberMe: type: boolean rememberMeDuration: type: integer format: int32 resetPasswordConfirmIdentity: type: boolean resetPasswordCustomForm: type: boolean resetPasswordCustomFormFields: type: array items: $ref: '#/components/schemas/FormField' resetPasswordInvalidateTokens: type: boolean sendRecoverAccountEmail: type: boolean sendVerifyRegistrationAccountEmail: type: boolean useBotDetection: type: boolean Application: type: object properties: certificate: type: string createdAt: type: string format: date-time description: type: string domain: type: string enabled: type: boolean factors: uniqueItems: true type: array items: type: string id: type: string identityProviders: uniqueItems: true type: array items: $ref: '#/components/schemas/ApplicationIdentityProvider' metadata: type: object additionalProperties: type: object name: type: string passwordSettings: $ref: '#/components/schemas/PasswordSettings' secretSettings: type: array items: $ref: '#/components/schemas/ApplicationSecretSettings' secrets: type: array items: $ref: '#/components/schemas/ClientSecret' settings: $ref: '#/components/schemas/ApplicationSettings' template: type: boolean type: type: string enum: - WEB - NATIVE - BROWSER - SERVICE - RESOURCE_SERVER updatedAt: type: string format: date-time ProtectedResourceFeature: type: object properties: createdAt: type: string format: date-time description: type: string key: type: string type: type: string enum: - MCP_TOOL updatedAt: type: string format: date-time discriminator: propertyName: type mapping: MCP_TOOL: '#/components/schemas/McpTool' CookieSettings: type: object properties: inherited: type: boolean session: $ref: '#/components/schemas/SessionSettings' PatchCIMDSettings: type: object properties: allowPrivateIpAddress: type: boolean allowUnsecuredHttpUri: type: boolean allowedDomains: type: array items: type: string cacheMaxEntries: type: integer format: int32 cacheTtlSeconds: type: integer format: int32 enabled: type: boolean fetchTimeoutMs: type: integer format: int32 maxResponseSizeKb: type: integer format: int32 revokeOnDocumentChange: type: boolean templateId: type: string Scope: type: object properties: claims: type: array items: type: string createdAt: type: string format: date-time description: type: string discovery: type: boolean domain: type: string expiresIn: type: integer format: int32 iconUri: type: string id: type: string key: type: string name: type: string parameterized: type: boolean system: type: boolean updatedAt: type: string format: date-time VirtualHost: type: object properties: host: type: string overrideEntrypoint: type: boolean path: type: string SelfServiceAccountManagementSettings: type: object properties: enabled: type: boolean resetPassword: $ref: '#/components/schemas/ResetPasswordSettings' ClientRegistrationSettings: type: object properties: allowHttpSchemeRedirectUri: type: boolean allowLocalhostRedirectUri: type: boolean allowRedirectUriParamsExpressionLanguage: type: boolean allowWildCardRedirectUri: type: boolean allowedScopes: type: array items: type: string allowedScopesEnabled: type: boolean clientTemplateEnabled: type: boolean defaultScopes: type: array items: type: string dynamicClientRegistrationEnabled: type: boolean openDynamicClientRegistrationEnabled: type: boolean NewUser: required: - username type: object properties: accountNonExpired: type: boolean accountNonLocked: type: boolean additionalInformation: type: object additionalProperties: type: object client: type: string createdAt: type: string format: date-time credentialsNonExpired: type: boolean domain: type: string email: type: string enabled: type: boolean externalId: type: string firstName: type: string forceResetPassword: type: boolean internal: type: boolean lastName: type: string lastPasswordReset: type: string format: date-time loggedAt: type: string format: date-time loginsCount: type: integer format: int64 password: type: string preRegistration: type: boolean preferredLanguage: type: string registrationCompleted: type: boolean source: type: string updatedAt: type: string format: date-time username: minLength: 1 type: string ScopePage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/Scope' totalCount: type: integer format: int64 PatchApplicationIdentityProvider: type: object properties: identity: type: string priority: type: integer format: int32 selectionRule: type: string DeviceIdentifier: type: object properties: configuration: type: string createdAt: type: string format: date-time id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time PreviewRequest: required: - template - type type: object properties: content: type: string template: type: string theme: $ref: '#/components/schemas/Theme' type: type: string enum: - EMAIL - FORM ApplicationPage: type: object properties: currentPage: type: integer format: int32 data: type: array items: $ref: '#/components/schemas/FilteredApplication' totalCount: type: integer format: int64 UpdateCertificate: required: - configuration - name - type type: object properties: configuration: type: string name: minLength: 1 type: string type: minLength: 1 type: string PatchApplication: type: object properties: certificate: type: string description: type: string enabled: type: boolean factors: uniqueItems: true type: array items: type: string identityProviders: uniqueItems: true type: array items: $ref: '#/components/schemas/PatchApplicationIdentityProvider' metadata: type: object additionalProperties: type: object name: type: string requiredPermissions: uniqueItems: true type: array items: type: string enum: - ORGANIZATION - ORGANIZATION_SETTINGS - ORGANIZATION_IDENTITY_PROVIDER - ORGANIZATION_AUDIT - ORGANIZATION_REPORTER - ORGANIZATION_SCOPE - ORGANIZATION_USER - ORGANIZATION_GROUP - ORGANIZATION_ROLE - ORGANIZATION_TAG - ORGANIZATION_ENTRYPOINT - ORGANIZATION_FORM - ORGANIZATION_MEMBER - ENVIRONMENT - DATA_PLANE - DOMAIN - DOMAIN_SETTINGS - DOMAIN_FORM - DOMAIN_EMAIL_TEMPLATE - DOMAIN_EXTENSION_POINT - DOMAIN_IDENTITY_PROVIDER - DOMAIN_AUTHORIZATION_ENGINE - DOMAIN_AUDIT - DOMAIN_CERTIFICATE - DOMAIN_USER - DOMAIN_USER_DEVICE - DOMAIN_GROUP - DOMAIN_ROLE - DOMAIN_SCIM - DOMAIN_SCOPE - DOMAIN_EXTENSION_GRANT - DOMAIN_OPENID - DOMAIN_SAML - DOMAIN_UMA - DOMAIN_UMA_SCOPE - DOMAIN_REPORTER - DOMAIN_MEMBER - DOMAIN_ANALYTICS - DOMAIN_FACTOR - DOMAIN_RESOURCE - DOMAIN_FLOW - DOMAIN_ALERT - DOMAIN_ALERT_NOTIFIER - DOMAIN_BOT_DETECTION - DOMAIN_DEVICE_IDENTIFIER - DOMAIN_AUTHDEVICE_NOTIFIER - DOMAIN_I18N_DICTIONARY - DOMAIN_THEME - APPLICATION - APPLICATION_SETTINGS - APPLICATION_IDENTITY_PROVIDER - APPLICATION_FORM - APPLICATION_EMAIL_TEMPLATE - APPLICATION_OPENID - APPLICATION_SAML - APPLICATION_CERTIFICATE - APPLICATION_MEMBER - APPLICATION_FACTOR - APPLICATION_RESOURCE - APPLICATION_ANALYTICS - APPLICATION_FLOW - LICENSE_NOTIFICATION - PROTECTED_RESOURCE - PROTECTED_RESOURCE_MEMBER - PROTECTED_RESOURCE_SETTINGS - PROTECTED_RESOURCE_OAUTH - PROTECTED_RESOURCE_CERTIFICATE - INSTALLATION settings: $ref: '#/components/schemas/PatchApplicationSettings' template: type: boolean PatchChallengeSettings: type: object properties: active: type: boolean challengeRule: type: string type: type: string enum: - REQUIRED - CONDITIONAL - RISK_BASED UpdateI18nDictionary: type: object properties: entries: type: object additionalProperties: type: string locale: type: string name: type: string NewCertificateCredential: required: - certificatePem type: object properties: certificatePem: minLength: 1 type: string description: The certificate in PEM format example: '-----BEGIN CERTIFICATE----- ... -----END CERTIFICATE-----' AlertTrigger: type: object properties: alertNotifiers: type: array items: type: string createdAt: type: string format: date-time enabled: type: boolean id: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string enum: - TOO_MANY_LOGIN_FAILURES - RISK_ASSESSMENT updatedAt: type: string format: date-time PatchApplicationSAMLSettings: type: object properties: assertionAttributes: type: array items: $ref: '#/components/schemas/SAMLAssertionAttribute' assertionValiditySeconds: type: integer format: int32 attributeConsumeServiceUrl: type: string audiences: type: array items: type: string certificate: type: string dataEncryptionAlgorithm: type: string entityId: type: string includeAssertionConditions: type: boolean keyTransportEncryptionAlgorithm: type: string nameIdMapping: type: string notBeforeTimeSkewSeconds: type: integer format: int32 notOnOrAfterTimeSkewSeconds: type: integer format: int32 responseBinding: type: string singleLogoutServiceUrl: type: string wantAssertionsEncrypted: type: boolean wantAssertionsSigned: type: boolean wantResponseSigned: type: boolean MFASettings: type: object properties: adaptiveAuthenticationRule: type: string challenge: $ref: '#/components/schemas/ChallengeSettings' enroll: $ref: '#/components/schemas/EnrollSettings' enrollment: $ref: '#/components/schemas/EnrollmentSettings' factor: $ref: '#/components/schemas/FactorSettings' loginRule: type: string rememberDevice: $ref: '#/components/schemas/RememberDeviceSettings' stepUpAuthentication: $ref: '#/components/schemas/StepUpAuthenticationSettings' stepUpAuthenticationRule: type: string ThemeEntity: type: object properties: createdAt: type: string format: date-time css: type: string faviconUrl: type: string id: type: string logoUrl: type: string logoWidth: type: integer format: int32 primaryButtonColorHex: type: string primaryTextColorHex: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE secondaryButtonColorHex: type: string secondaryTextColorHex: type: string updatedAt: type: string format: date-time PatchCIBASettings: type: object properties: authReqExpiry: type: integer format: int32 bindingMessageLength: type: integer format: int32 deviceNotifiers: type: array items: $ref: '#/components/schemas/CIBASettingNotifier' enabled: type: boolean tokenReqInterval: type: integer format: int32 EnrolledFactorChannel: type: object properties: additionalData: type: object additionalProperties: type: object target: type: string type: type: string enum: - SMS - EMAIL - HTTP - CALL BulkResponse: type: object properties: allSuccessful: type: boolean results: type: array items: $ref: '#/components/schemas/BulkOperationResultObject' UpdateIdentityProvider: required: - configuration - name - type type: object properties: configuration: type: string domainWhitelist: type: array items: type: string groupMapper: type: object additionalProperties: type: array items: type: string mappers: type: object additionalProperties: type: string name: type: string passwordPolicy: type: string roleMapper: type: object additionalProperties: type: array items: type: string type: minLength: 1 type: string AuditAccessPoint: type: object properties: alternativeId: type: string displayName: type: string id: type: string ipAddress: type: string userAgent: type: string AnalyticsTypeParam: type: object properties: originalParam: type: string value: type: string enum: - DATE_HISTO - COUNT - GROUP_BY NewAuthenticationDeviceNotifier: required: - configuration - name - type type: object properties: configuration: type: string id: type: string name: type: string type: type: string NewExtensionGrant: required: - configuration - grantType - name - type type: object properties: configuration: type: string createUser: type: boolean grantType: pattern: '[A-Za-z][A-Za-z0-9+\-.]*:(?://(?:(?:[A-Za-z0-9\-._~!$&''()*+,;=:]|%[0-9A-Fa-f]{2})*@)?(?:\[(?:(?:(?:(?:[0-9A-Fa-f]{1,4}:){6}|::(?:[0-9A-Fa-f]{1,4}:){5}|(?:[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,1}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){3}|(?:(?:[0-9A-Fa-f]{1,4}:){0,2}[0-9A-Fa-f]{1,4})?::(?:[0-9A-Fa-f]{1,4}:){2}|(?:(?:[0-9A-Fa-f]{1,4}:){0,3}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}:|(?:(?:[0-9A-Fa-f]{1,4}:){0,4}[0-9A-Fa-f]{1,4})?::)(?:[0-9A-Fa-f]{1,4}:[0-9A-Fa-f]{1,4}|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?))|(?:(?:[0-9A-Fa-f]{1,4}:){0,5}[0-9A-Fa-f]{1,4})?::[0-9A-Fa-f]{1,4}|(?:(?:[0-9A-Fa-f]{1,4}:){0,6}[0-9A-Fa-f]{1,4})?::)|[Vv][0-9A-Fa-f]+\.[A-Za-z0-9\-._~!$&''()*+,;=:]+)\]|(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)|(?:[A-Za-z0-9\-._~!$&''()*+,;=]|%[0-9A-Fa-f]{2})*)(?::[0-9]*)?(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*|/(?:(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*)?|(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})+(?:/(?:[A-Za-z0-9\-._~!$&''()*+,;=:@]|%[0-9A-Fa-f]{2})*)*|)(?:\?(?:[A-Za-z0-9\-._~!$&''()*+,;=:@/?]|%[0-9A-Fa-f]{2})*)?' type: string identityProvider: type: string name: type: string type: type: string userExists: type: boolean RiskAssessmentSettings: type: object properties: deviceAssessment: $ref: '#/components/schemas/AssessmentSettings' enabled: type: boolean geoVelocityAssessment: $ref: '#/components/schemas/AssessmentSettings' ipReputationAssessment: $ref: '#/components/schemas/AssessmentSettings' AuthenticationDeviceNotifier: type: object properties: configuration: type: string createdAt: type: string format: date-time id: type: string name: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE type: type: string updatedAt: type: string format: date-time Factor: type: object properties: configuration: type: string createdAt: type: string format: date-time domain: type: string factorType: type: string enum: - OTP - SMS - EMAIL - CALL - HTTP - RECOVERY_CODE - FIDO2 - MOCK id: type: string name: type: string type: type: string updatedAt: type: string format: date-time Theme: type: object properties: createdAt: type: string format: date-time css: type: string faviconUrl: type: string id: type: string logoUrl: type: string logoWidth: type: integer format: int32 primaryButtonColorHex: type: string primaryTextColorHex: type: string referenceId: type: string referenceType: type: string enum: - PLATFORM - DOMAIN - APPLICATION - ORGANIZATION - ENVIRONMENT - PROTECTED_RESOURCE secondaryButtonColorHex: type: string secondaryTextColorHex: type: string updatedAt: type: string format: date-time EnrollmentSettings: type: object properties: forceEnrollment: type: boolean skipTimeSeconds: type: integer format: int64 TokenExchangeOAuthSettings: type: object properties: inherited: type: boolean scopeHandling: type: string enum: - DOWNSCOPING - PERMISSIVE securitySchemes: gravitee-auth: type: http scheme: Bearer