{ "opencollection": "1.0.0", "info": { "name": "Gravitee.io - Access Management alerts domain API", "version": "4.12.0-alpha.3" }, "items": [ { "info": { "name": "domain", "type": "folder" }, "items": [ { "info": { "name": "List security domains for an environment", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a security domain.", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a security domain. User must have DOMAIN[CREATE] permission on the specified environment or DOMAIN[CREATE] permission on the specified organization" }, { "info": { "name": "Get a security domain by hrid", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/_hrid/:hrid", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "hrid", "value": "", "type": "path" } ] }, "docs": "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)" }, { "info": { "name": "Get a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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)" }, { "info": { "name": "Update the security domain", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Patch the security domain", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Delete the security domain", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "List alert notifiers", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/notifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "List all the alert notifiers of the domain. User must have DOMAIN_ALERT_NOTIFIER[LIST] permission on the specified domain, environment or organization." }, { "info": { "name": "Create an alert notifier", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/notifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new alert notifierUser must have DOMAIN_ALERT_NOTIFIER[CREATE] permission on the specified domain, environment or organization." }, { "info": { "name": "Get an alert notifier", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/notifiers/:notifierId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "notifierId", "value": "", "type": "path" } ] }, "docs": "Get an alert notifier by its id. User must have DOMAIN_ALERT_NOTIFIER[LIST] permission on the specified domain, environment or organization." }, { "info": { "name": "Update an alert notifier", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/notifiers/:notifierId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "notifierId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update an alert notifierUser must have DOMAIN_ALERT_NOTIFIER[UPDATE] permission on the specified domain, environment or organization." }, { "info": { "name": "Delete an alert notifier", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/notifiers/:notifierId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "notifierId", "value": "", "type": "path" } ] }, "docs": "Delete an alert notifier by its id. User must have DOMAIN_ALERT_NOTIFIER[DELETE] permission on the specified domain, environment or organization." }, { "info": { "name": "List alert triggers", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/triggers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update multiple alert triggers", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/alerts/triggers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update multiple alert triggers in the same timeUser must have DOMAIN_ALERT[UPDATE] permission on the specified domain, environment or organization." }, { "info": { "name": "Find domain analytics", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/analytics", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "from", "value": "", "type": "query", "description": "Used to define the start date of the time window to query" }, { "name": "to", "value": "", "type": "query", "description": "Used to define the end date of the time window to query" }, { "name": "interval", "value": "", "type": "query", "description": "The time interval when getting histogram data" }, { "name": "size", "value": "", "type": "query", "description": "The number of data to retrieve" }, { "name": "type", "value": "", "type": "query", "description": "The type of data to retrieve (group_by, date_histo, count)" }, { "name": "field", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "List registered applications for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" }, { "name": "expand", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create an application", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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)" }, { "info": { "name": "Update an application", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Patch an application", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an application", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Find application analytics", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/analytics", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "from", "value": "", "type": "query", "description": "Used to define the start date of the time window to query" }, { "name": "to", "value": "", "type": "query", "description": "Used to define the end date of the time window to query" }, { "name": "interval", "value": "", "type": "query", "description": "The time interval when getting histogram data" }, { "name": "size", "value": "", "type": "query", "description": "The number of data to retrieve" }, { "name": "type", "value": "", "type": "query", "description": "The type of data to retrieve (group_by, date_histo, count)" }, { "name": "field", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Find a email for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/emails", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "template", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Create a email for an application", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/emails", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Update an email for an application", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/emails/:email", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an email for an application", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/emails/:email", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "email", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered flows for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/flows", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create or update list of flows", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/flows", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a flow", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/flows/:flow", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "flow", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a flow", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/flows/:flow", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "flow", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Find a form for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/forms", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "template", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Create a form for an application", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/forms", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Update a form for an application", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/forms/:form", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "form", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a form for an application", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/forms/:form", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "form", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List members for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Add or update an application member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "List application member's permissions", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/members/permissions", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Remove a membership", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List resources for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/resources", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Get a resource for an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/resources/:resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get resource access policies", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/resources/:resource/policies", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get resource access policy", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/resources/:resource/policies/:policy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List secrets of an application", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/secrets", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Create a secret for an application", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/secrets", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a secret of an application", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/secrets/:secret", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "secret", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Renew application secret", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/secrets/:secret/_renew", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" }, { "name": "secret", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update an application type", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/applications/:application/type", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "application", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "List audit logs for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/audits", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "user", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Get an audit log", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/audits/:audit", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "audit", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered Authentication Device Notifiers for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/auth-device-notifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create an Authentication Device Notifier", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/auth-device-notifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get an Authentication Device Notifier", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/auth-device-notifiers/:authDeviceNotifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "authDeviceNotifier", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update an Authentication Device Notifier", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/auth-device-notifiers/:authDeviceNotifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "authDeviceNotifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an Authentication Device Notifier", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/auth-device-notifiers/:authDeviceNotifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "authDeviceNotifier", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered authorization engines for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/authorization-engines", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create an authorization engine", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/authorization-engines", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get an authorization engine", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/authorization-engines/:engineId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "engineId", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update an authorization engine", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/authorization-engines/:engineId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "engineId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an authorization engine", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/authorization-engines/:engineId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "engineId", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered bot detections for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/bot-detections", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a bot detection", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/bot-detections", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a bot detection", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/bot-detections/:botDetection", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "botDetection", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a bot detection", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/bot-detections/:botDetection", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "botDetection", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a bot detection", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/bot-detections/:botDetection", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "botDetection", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update the security domain certificate settings", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificate-settings", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "List registered certificates for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "use", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a certificate", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Generate a new System a certificate", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/rotate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a certificate", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/:certificate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "certificate", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a certificate", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/:certificate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "certificate", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a certificate", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/:certificate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "certificate", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get the certificate public key", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/:certificate/key", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "certificate", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get the certificate public keys", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/certificates/:certificate/keys", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "certificate", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Create an application from a CIMD document URL", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/cimd/applications", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have APPLICATION[CREATE] permission on the specified domain" }, { "info": { "name": "Validate a CIMD URL and return parsed metadata preview", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/cimd/validate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have APPLICATION[CREATE] permission on the specified domain" }, { "info": { "name": "List registered device identifiers for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/device-identifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a device identifier", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/device-identifiers", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a Device identifier", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/device-identifiers/:deviceIdentifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "deviceIdentifier", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a Device identifier", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/device-identifiers/:deviceIdentifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "deviceIdentifier", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a Device identifier", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/device-identifiers/:deviceIdentifier", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "deviceIdentifier", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Find a email", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/emails", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "template", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Create a email", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/emails", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Update an email", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/emails/:email", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "email", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an email", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/emails/:email", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "email", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get the matching gateway entrypoint of the domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/entrypoints", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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)" }, { "info": { "name": "List registered extension grants for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/extensionGrants", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a extension grant", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/extensionGrants", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a extension grant", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/extensionGrants/:extensionGrant", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "extensionGrant", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update an extension grant", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/extensionGrants/:extensionGrant", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "extensionGrant", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a extension grant", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/extensionGrants/:extensionGrant", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "extensionGrant", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered factors for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/factors", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a factor", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/factors", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a factor", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/factors/:factor", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "factor", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a factor", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/factors/:factor", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "factor", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a factor", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/factors/:factor", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "factor", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered flows for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/flows", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create or update list of flows", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/flows", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a flow", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/flows/:flow", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "flow", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a flow", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/flows/:flow", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "flow", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Find a form", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/forms", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "template", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Create a form", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/forms", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Render the provided template", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/forms/preview", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Update a form", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/forms/:form", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "form", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a form", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/forms/:form", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "form", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List groups for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a group", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List group members", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Add a group member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Remove a group member", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a group roles", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Assign roles to a group", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Revoke role to a group", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/groups/:group/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "group", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List all i18n dictionaries supported for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a new i18n dictionary for a supported language for a security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Get a i18n dictionary", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries/:dictionary", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "dictionary", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update a i18n dictionary description", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries/:dictionary", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "dictionary", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Delete a i18n dictionary", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries/:dictionary", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "dictionary", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Update all the entries for a i18n dictionary description", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/i18n/dictionaries/:dictionary/entries", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "dictionary", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "List registered identity providers for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "userProvider", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create an identity provider", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get an identity provider", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities/:identity", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update an identity provider", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities/:identity", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete an identity provider", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities/:identity", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Assign password policy to identity provider", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/identities/:identity/password-policy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "List members for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Add or update an security domain member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "List domain member's permissions", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/members/permissions", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Remove a membership", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered password policies for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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. " }, { "info": { "name": "Create a password policy", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "getEffectivePasswordPolicy", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/activePolicy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "query" } ] } }, { "info": { "name": "Read a password policy", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/:policy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a password policy", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/:policy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a password policy", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/:policy", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Set default policy", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/:policy/default", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "evaluatePolicy", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/password-policies/:policy/evaluate", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "policy", "value": "", "type": "path" } ] } }, { "info": { "name": "List registered protected resources for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query" }, { "name": "type", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "sort", "value": "", "type": "query" } ] }, "docs": "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, descripti" }, { "info": { "name": "Create a Protected Resource definition", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a Protected Resource", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" } ] }, "docs": "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. " }, { "info": { "name": "Update a Protected Resource", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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. " }, { "info": { "name": "Patch a Protected Resource", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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. " }, { "info": { "name": "Delete a Protected Resource", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" } ] }, "docs": "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. " }, { "info": { "name": "List members for an protected resource", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Add or update an protected resource member", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/members", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "List protected resource member's permissions", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/members/permissions", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Remove a membership", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/members/:member", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" }, { "name": "member", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List secrets of a protected resource", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/secrets", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a secret for a protected resource", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/secrets", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Remove a secret for a protected resource", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/secrets/:secretId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" }, { "name": "secretId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Renew a secret for a protected resource", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/protected-resources/:protected-resource/secrets/:secretId/_renew", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "protected-resource", "value": "", "type": "path" }, { "name": "secretId", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "List registered reporters for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "userProvider", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a reporter for a security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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." }, { "info": { "name": "Get a reporter", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a reporter", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a reporter", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/reporters/:reporter", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "reporter", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered resources for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/resources", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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." }, { "info": { "name": "Create a resource", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/resources", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a resource", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/resources/:resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a resource", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/resources/:resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a resource", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/resources/:resource", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "resource", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List registered roles for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a role", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a role", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a role", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a role", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List scopes for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "q", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a scope", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a scope", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes/:scope", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a scope", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes/:scope", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Patch a scope", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes/:scope", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a scope", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/scopes/:scope", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "scope", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List themes on the specified security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/themes", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Create a theme on the specified security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/themes", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get the theme linked to the specified security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/themes/:themeId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "themeId", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a theme on the specified security domain", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/themes/:themeId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "themeId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a theme on the specified security domain", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/themes/:themeId", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "themeId", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List users for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "q", "value": "", "type": "query" }, { "name": "filter", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" } ] }, "docs": "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." }, { "info": { "name": "Create a user on the specified security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Create/update/delete multiple users on the specified security domain", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/bulk", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "User must have the DOMAIN_USER[CREATE/UPDATE/DELETE] permission on the specified domain, the environment, or the organization" }, { "info": { "name": "Get a user", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a user", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Delete a user", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user audit logs", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/audits", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "type", "value": "", "type": "query" }, { "name": "status", "value": "", "type": "query" }, { "name": "from", "value": "", "type": "query" }, { "name": "to", "value": "", "type": "query" }, { "name": "size", "value": "", "type": "query" }, { "name": "page", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Get a user audit log", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/audits/:audit", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "audit", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get user certificate credentials", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Enroll a certificate credential for a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Get a user certificate credential", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Revoke a user certificate credential", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/cert-credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user consents", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Revoke user consents", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "clientId", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Get a user consent", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents/:consent", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "consent", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Revoke a user consent", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/consents/:consent", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "consent", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user credentials", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user credential", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Revoke a user credential", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/credentials/:credential", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "credential", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "List users for a security domain", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/devices", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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. " }, { "info": { "name": "Delete a device", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/devices/:device", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "device", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user enrolled factors", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/factors", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Revoke user factor", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/factors/:factor", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "factor", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user linked identities", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/identities", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Unlink user identity", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/identities/:identity", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "identity", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Lock a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/lock", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Reset password", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/resetPassword", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Get a user roles", "type": "http" }, "http": { "method": "GET", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "dynamic", "value": "", "type": "query" } ] }, "docs": "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" }, { "info": { "name": "Assign roles to a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Revoke role to a user", "type": "http" }, "http": { "method": "DELETE", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/roles/:role", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" }, { "name": "role", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Send registration confirmation email", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/sendRegistrationConfirmation", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a user status", "type": "http" }, "http": { "method": "PUT", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/status", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" }, { "info": { "name": "Unlock a user", "type": "http" }, "http": { "method": "POST", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/unlock", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ] }, "docs": "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" }, { "info": { "name": "Update a user username", "type": "http" }, "http": { "method": "PATCH", "url": "/management/organizations/:organizationId/environments/:environmentId/domains/:domain/users/:user/username", "params": [ { "name": "organizationId", "value": "", "type": "path" }, { "name": "environmentId", "value": "", "type": "path" }, { "name": "domain", "value": "", "type": "path" }, { "name": "user", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "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" } ] } ], "bundled": true }