diff --git a/spec/namespaces/security.yaml b/spec/namespaces/security.yaml index 911f27f85..c18f50001 100644 --- a/spec/namespaces/security.yaml +++ b/spec/namespaces/security.yaml @@ -51,18 +51,6 @@ paths: '200': $ref: '#/components/responses/security.patch_action_groups@200' /_plugins/_security/api/actiongroups/{action_group}: - delete: - operationId: security.delete_action_group.0 - x-operation-group: security.delete_action_group - x-version-added: '1.0' - description: Delete a specified action group. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group - parameters: - - $ref: '#/components/parameters/security.delete_action_group::path.action_group' - responses: - '200': - $ref: '#/components/responses/security.delete_action_group@200' get: operationId: security.get_action_group.0 x-operation-group: security.get_action_group @@ -75,6 +63,20 @@ paths: responses: '200': $ref: '#/components/responses/security.get_action_group@200' + put: + operationId: security.create_action_group.0 + x-operation-group: security.create_action_group + x-version-added: '1.0' + description: Creates or replaces the specified action group. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group + parameters: + - $ref: '#/components/parameters/security.create_action_group::path.action_group' + requestBody: + $ref: '#/components/requestBodies/security.create_action_group' + responses: + '200': + $ref: '#/components/responses/security.create_action_group@200' patch: operationId: security.patch_action_group.0 x-operation-group: security.patch_action_group @@ -89,20 +91,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_action_group@200' - put: - operationId: security.create_action_group.0 - x-operation-group: security.create_action_group + delete: + operationId: security.delete_action_group.0 + x-operation-group: security.delete_action_group x-version-added: '1.0' - description: Creates or replaces the specified action group. + description: Delete a specified action group. externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#create-action-group + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.create_action_group::path.action_group' - requestBody: - $ref: '#/components/requestBodies/security.create_action_group' + - $ref: '#/components/parameters/security.delete_action_group::path.action_group' responses: '200': - $ref: '#/components/responses/security.create_action_group@200' + $ref: '#/components/responses/security.delete_action_group@200' /_plugins/_security/api/allowlist: get: operationId: security.get_allowlist.0 @@ -114,20 +114,6 @@ paths: responses: '200': $ref: '#/components/responses/security.get_allowlist@200' - patch: - operationId: security.patch_allowlist.0 - x-operation-group: security.patch_allowlist - x-version-added: '1.0' - description: Updates the current list of allowed API accessible to normal user. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api - parameters: - - $ref: '#/components/parameters/security.patch_allowlist::path.patch_allowlist' - requestBody: - $ref: '#/components/requestBodies/security.patch_allowlist' - responses: - '200': - $ref: '#/components/responses/security.patch_allowlist@200' put: operationId: security.put_allowlist.0 x-operation-group: security.create_allowlist @@ -142,6 +128,20 @@ paths: responses: '200': $ref: '#/components/responses/security.create_allowlist@200' + patch: + operationId: security.patch_allowlist.0 + x-operation-group: security.patch_allowlist + x-version-added: '1.0' + description: Updates the current list of allowed API accessible to normal user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api + parameters: + - $ref: '#/components/parameters/security.patch_allowlist::path.patch_allowlist' + requestBody: + $ref: '#/components/requestBodies/security.patch_allowlist' + responses: + '200': + $ref: '#/components/responses/security.patch_allowlist@200' /_plugins/_security/api/audit: get: operationId: security.get_audit_configuration.0 @@ -232,16 +232,6 @@ paths: '200': $ref: '#/components/responses/security.post_upgrade_perform@200' /_plugins/_security/api/cache: - delete: - operationId: security.flush_cache.0 - x-operation-group: security.flush_cache - x-version-added: '1.0' - description: Flushes the Security plugin user, authentication, and authorization cache. - externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache - responses: - '200': - $ref: '#/components/responses/security.flush_cache@200' get: operationId: security.get_cache.0 x-operation-group: security.get_cache @@ -250,6 +240,16 @@ paths: responses: '200': $ref: '#/components/responses/security.get_cache@200' + post: + operationId: security.post_cache.0 + x-operation-group: security.post_cache + x-version-added: '1.0' + description: Updates the Security plugin user, authentication, and authorization cache. + requestBody: + $ref: '#/components/requestBodies/security.post_cache' + responses: + '200': + $ref: '#/components/responses/security.post_cache@200' put: operationId: security.put_cache.0 x-operation-group: security.put_cache @@ -260,16 +260,16 @@ paths: responses: '200': $ref: '#/components/responses/security.put_cache@200' - post: - operationId: security.post_cache.0 - x-operation-group: security.post_cache + delete: + operationId: security.flush_cache.0 + x-operation-group: security.flush_cache x-version-added: '1.0' - description: Updates the Security plugin user, authentication, and authorization cache. - requestBody: - $ref: '#/components/requestBodies/security.post_cache' + description: Flushes the Security plugin user, authentication, and authorization cache. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#flush-cache responses: '200': - $ref: '#/components/responses/security.post_cache@200' + $ref: '#/components/responses/security.flush_cache@200' /_plugins/_security/api/internalusers: get: operationId: security.get_users.0 @@ -294,18 +294,6 @@ paths: '200': $ref: '#/components/responses/security.patch_users@200' /_plugins/_security/api/internalusers/{username}: - delete: - operationId: security.delete_user.0 - x-operation-group: security.delete_user - x-version-added: '1.0' - description: Delete the specified user. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user - parameters: - - $ref: '#/components/parameters/security.delete_user::path.username' - responses: - '200': - $ref: '#/components/responses/security.delete_user@200' get: operationId: security.get_user.0 x-operation-group: security.get_user @@ -318,6 +306,20 @@ paths: responses: '200': $ref: '#/components/responses/security.get_user@200' + put: + operationId: security.create_user.0 + x-operation-group: security.create_user + x-version-added: '1.0' + description: Creates or replaces the specified user. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-user + parameters: + - $ref: '#/components/parameters/security.create_user::path.username' + requestBody: + $ref: '#/components/requestBodies/security.create_user' + responses: + '200': + $ref: '#/components/responses/security.create_user@200' patch: operationId: security.patch_user.0 x-operation-group: security.patch_user @@ -332,20 +334,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_user@200' - put: - operationId: security.create_user.0 - x-operation-group: security.create_user + delete: + operationId: security.delete_user.0 + x-operation-group: security.delete_user x-version-added: '1.0' - description: Creates or replaces the specified user. + description: Delete the specified user. externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#create-user + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-user parameters: - - $ref: '#/components/parameters/security.create_user::path.username' - requestBody: - $ref: '#/components/requestBodies/security.create_user' + - $ref: '#/components/parameters/security.delete_user::path.username' responses: '200': - $ref: '#/components/responses/security.create_user@200' + $ref: '#/components/responses/security.delete_user@200' /_plugins/_security/api/internalusers/{username}/authtoken: post: operationId: security.post_user_token.0 @@ -367,16 +367,6 @@ paths: '200': $ref: '#/components/responses/security.get_user_legacy@200' /_plugins/_security/api/user/{username}: - delete: - operationId: security.delete_user_legacy.0 - x-operation-group: security.delete_user_legacy - x-version-added: '1.0' - description: Delete the specified user. Legacy API. - parameters: - - $ref: '#/components/parameters/security.delete_user_legacy::path.username' - responses: - '200': - $ref: '#/components/responses/security.delete_user_legacy@200' get: operationId: security.get_user_legacy.0 x-operation-group: security.get_user_legacy @@ -399,6 +389,16 @@ paths: responses: '200': $ref: '#/components/responses/security.create_user_legacy@200' + delete: + operationId: security.delete_user_legacy.0 + x-operation-group: security.delete_user_legacy + x-version-added: '1.0' + description: Delete the specified user. Legacy API. + parameters: + - $ref: '#/components/parameters/security.delete_user_legacy::path.username' + responses: + '200': + $ref: '#/components/responses/security.delete_user_legacy@200' /_plugins/_security/api/user/{username}/authtoken: post: operationId: security.post_user_token_legacy.0 @@ -445,18 +445,6 @@ paths: '200': $ref: '#/components/responses/security.patch_distinguished_names@200' /_plugins/_security/api/nodesdn/{cluster_name}: - delete: - operationId: security.delete_distinguished_names.0 - x-operation-group: security.delete_distinguished_names - x-version-added: '1.0' - description: Deletes all distinguished names in the specified cluster’s or node’s allow list. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names - parameters: - - $ref: '#/components/parameters/security.delete_distinguished_names::path.cluster_name' - responses: - '200': - $ref: '#/components/responses/security.delete_distinguished_names@200' get: operationId: security.get_distinguished_names.1 x-operation-group: security.get_distinguished_names @@ -493,6 +481,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_distinguished_name@200' + delete: + operationId: security.delete_distinguished_names.0 + x-operation-group: security.delete_distinguished_names + x-version-added: '1.0' + description: Deletes all distinguished names in the specified cluster’s or node’s allow list. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names + parameters: + - $ref: '#/components/parameters/security.delete_distinguished_names::path.cluster_name' + responses: + '200': + $ref: '#/components/responses/security.delete_distinguished_names@200' /_plugins/_security/api/permissionsinfo: get: operationId: security.get_permissions_info.1 @@ -516,18 +516,6 @@ paths: '200': $ref: '#/components/responses/security.get_validate@200' /_plugins/_security/api/roles: - patch: - operationId: security.patch_roles.0 - x-operation-group: security.patch_roles - x-version-added: '1.0' - description: Creates, updates, or deletes multiple roles in a single call. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles - requestBody: - $ref: '#/components/requestBodies/security.patch_roles' - responses: - '200': - $ref: '#/components/responses/security.patch_roles@200' get: operationId: security.get_roles.0 x-operation-group: security.get_roles @@ -538,19 +526,19 @@ paths: responses: '200': $ref: '#/components/responses/security.get_roles@200' - /_plugins/_security/api/roles/{role}: - delete: - operationId: security.delete_role.0 - x-operation-group: security.delete_role + patch: + operationId: security.patch_roles.0 + x-operation-group: security.patch_roles x-version-added: '1.0' - description: Delete the specified role. + description: Creates, updates, or deletes multiple roles in a single call. externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role - parameters: - - $ref: '#/components/parameters/security.delete_role::path.role' + url: https://opensearch.org/docs/latest/security/access-control/api/#patch-roles + requestBody: + $ref: '#/components/requestBodies/security.patch_roles' responses: '200': - $ref: '#/components/responses/security.delete_role@200' + $ref: '#/components/responses/security.patch_roles@200' + /_plugins/_security/api/roles/{role}: get: operationId: security.get_role.0 x-operation-group: security.get_role @@ -563,6 +551,20 @@ paths: responses: '200': $ref: '#/components/responses/security.get_role@200' + put: + operationId: security.create_role.0 + x-operation-group: security.create_role + x-version-added: '1.0' + description: Creates or replaces the specified role. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role + parameters: + - $ref: '#/components/parameters/security.create_role::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role' + responses: + '200': + $ref: '#/components/responses/security.create_role@200' patch: operationId: security.patch_role.0 x-operation-group: security.patch_role @@ -577,20 +579,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_role@200' - put: - operationId: security.create_role.0 - x-operation-group: security.create_role + delete: + operationId: security.delete_role.0 + x-operation-group: security.delete_role x-version-added: '1.0' - description: Creates or replaces the specified role. + description: Delete the specified role. externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#create-role + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role parameters: - - $ref: '#/components/parameters/security.create_role::path.role' - requestBody: - $ref: '#/components/requestBodies/security.create_role' + - $ref: '#/components/parameters/security.delete_role::path.role' responses: '200': - $ref: '#/components/responses/security.create_role@200' + $ref: '#/components/responses/security.delete_role@200' /_plugins/_security/api/rolesmapping: get: operationId: security.get_role_mappings.0 @@ -615,18 +615,6 @@ paths: '200': $ref: '#/components/responses/security.patch_role_mappings@200' /_plugins/_security/api/rolesmapping/{role}: - delete: - operationId: security.delete_role_mapping.0 - x-operation-group: security.delete_role_mapping - x-version-added: '1.0' - description: Deletes the specified role mapping. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping - parameters: - - $ref: '#/components/parameters/security.delete_role_mapping::path.role' - responses: - '200': - $ref: '#/components/responses/security.delete_role_mapping@200' get: operationId: security.get_role_mapping.0 x-operation-group: security.get_role_mapping @@ -639,6 +627,20 @@ paths: responses: '200': $ref: '#/components/responses/security.get_role_mapping@200' + put: + operationId: security.create_role_mapping.0 + x-operation-group: security.create_role_mapping + x-version-added: '1.0' + description: Creates or replaces the specified role mapping. + externalDocs: + url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping + parameters: + - $ref: '#/components/parameters/security.create_role_mapping::path.role' + requestBody: + $ref: '#/components/requestBodies/security.create_role_mapping' + responses: + '200': + $ref: '#/components/responses/security.create_role_mapping@200' patch: operationId: security.patch_role_mapping.0 x-operation-group: security.patch_role_mapping @@ -653,20 +655,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_role_mapping@200' - put: - operationId: security.create_role_mapping.0 - x-operation-group: security.create_role_mapping + delete: + operationId: security.delete_role_mapping.0 + x-operation-group: security.delete_role_mapping x-version-added: '1.0' - description: Creates or replaces the specified role mapping. + description: Deletes the specified role mapping. externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping parameters: - - $ref: '#/components/parameters/security.create_role_mapping::path.role' - requestBody: - $ref: '#/components/requestBodies/security.create_role_mapping' + - $ref: '#/components/parameters/security.delete_role_mapping::path.role' responses: '200': - $ref: '#/components/responses/security.create_role_mapping@200' + $ref: '#/components/responses/security.delete_role_mapping@200' /_plugins/_security/api/securityconfig: get: operationId: security.get_configuration.0 @@ -769,18 +769,6 @@ paths: '200': $ref: '#/components/responses/security.patch_tenants@200' /_plugins/_security/api/tenants/{tenant}: - delete: - operationId: security.delete_tenant.0 - x-operation-group: security.delete_tenant - x-version-added: '1.0' - description: Delete the specified tenant. - externalDocs: - url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group - parameters: - - $ref: '#/components/parameters/security.delete_tenant::path.tenant' - responses: - '200': - $ref: '#/components/responses/security.delete_tenant@200' get: operationId: security.get_tenant.0 x-operation-group: security.get_tenant @@ -793,6 +781,20 @@ paths: responses: '200': $ref: '#/components/responses/security.get_tenant@200' + put: + operationId: security.create_tenant.0 + x-operation-group: security.create_tenant + x-version-added: '1.0' + description: Creates or replaces the specified tenant. + externalDocs: + url: https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant + parameters: + - $ref: '#/components/parameters/security.create_tenant::path.tenant' + requestBody: + $ref: '#/components/requestBodies/security.create_tenant' + responses: + '200': + $ref: '#/components/responses/security.create_tenant@200' patch: operationId: security.patch_tenant.0 x-operation-group: security.patch_tenant @@ -807,20 +809,18 @@ paths: responses: '200': $ref: '#/components/responses/security.patch_tenant@200' - put: - operationId: security.create_tenant.0 - x-operation-group: security.create_tenant + delete: + operationId: security.delete_tenant.0 + x-operation-group: security.delete_tenant x-version-added: '1.0' - description: Creates or replaces the specified tenant. + description: Delete the specified tenant. externalDocs: - url: https://opensearch.org/docs/2.7/security/access-control/api/#create-tenant + url: https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group parameters: - - $ref: '#/components/parameters/security.create_tenant::path.tenant' - requestBody: - $ref: '#/components/requestBodies/security.create_tenant' + - $ref: '#/components/parameters/security.delete_tenant::path.tenant' responses: '200': - $ref: '#/components/responses/security.create_tenant@200' + $ref: '#/components/responses/security.delete_tenant@200' /_plugins/_security/api/tenantinfo: get: operationId: security.get_tenant_info.0