Class LowLevelSecurityNamespace

Security APIs.

Not intended to be instantiated directly. Use the Security property on IOpenSearchLowLevelClient.

Inheritance

object

NamespacedClientProxy

LowLevelSecurityNamespace

Inherited Members

NamespacedClientProxy.DoRequest<TResponse>(HttpMethod, string, PostData, IRequestParameters)

NamespacedClientProxy.DoRequestAsync<TResponse>(HttpMethod, string, CancellationToken, PostData, IRequestParameters)

NamespacedClientProxy.Url(FormattableString)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams, string)

NamespacedClientProxy.RequestParams<TRequestParams>(TRequestParams)

NamespacedClientProxy.ContentType

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: OpenSearch.Net.Specification.SecurityApi

Assembly: OpenSearch.Net.dll

Syntax

public class LowLevelSecurityNamespace : NamespacedClientProxy

Methods

| Edit this page View Source

AuthinfoAsync<TResponse>(AuthinfoRequestParameters, CancellationToken)

POST on /_plugins/_security/authinfo

Declaration

public Task<TResponse> AuthinfoAsync<TResponse>(AuthinfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
AuthinfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Authinfo<TResponse>(AuthinfoRequestParameters)

POST on /_plugins/_security/authinfo

Declaration

public TResponse Authinfo<TResponse>(AuthinfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
AuthinfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

AuthtokenAsync<TResponse>(AuthtokenRequestParameters, CancellationToken)

POST on /_plugins/_security/api/authtoken

Declaration

public Task<TResponse> AuthtokenAsync<TResponse>(AuthtokenRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
AuthtokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Authtoken<TResponse>(AuthtokenRequestParameters)

POST on /_plugins/_security/api/authtoken

Declaration

public TResponse Authtoken<TResponse>(AuthtokenRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
AuthtokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CacheAsync<TResponse>(CacheRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/cache

Declaration

public Task<TResponse> CacheAsync<TResponse>(CacheRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Cache<TResponse>(CacheRequestParameters)

PUT on /_plugins/_security/api/cache

Declaration

public TResponse Cache<TResponse>(CacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
CacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ChangePasswordAsync<TResponse>(PostData, ChangePasswordRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/account

https://opensearch.org/docs/latest/security/access-control/api/#change-password

Declaration

public Task<TResponse> ChangePasswordAsync<TResponse>(PostData body, ChangePasswordRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
ChangePasswordRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ChangePassword<TResponse>(PostData, ChangePasswordRequestParameters)

PUT on /_plugins/_security/api/account

https://opensearch.org/docs/latest/security/access-control/api/#change-password

Declaration

public TResponse ChangePassword<TResponse>(PostData body, ChangePasswordRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
ChangePasswordRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ConfigUpgradeCheckAsync<TResponse>(ConfigUpgradeCheckRequestParameters, CancellationToken)

GET on /_plugins/_security/api/_upgrade_check

https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check

Declaration

public Task<TResponse> ConfigUpgradeCheckAsync<TResponse>(ConfigUpgradeCheckRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ConfigUpgradeCheckRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.14.0 or greater.

| Edit this page View Source

ConfigUpgradeCheck<TResponse>(ConfigUpgradeCheckRequestParameters)

GET on /_plugins/_security/api/_upgrade_check

https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade-check

Declaration

public TResponse ConfigUpgradeCheck<TResponse>(ConfigUpgradeCheckRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ConfigUpgradeCheckRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.14.0 or greater.

| Edit this page View Source

ConfigUpgradePerformAsync<TResponse>(PostData, ConfigUpgradePerformRequestParameters, CancellationToken)

POST on /_plugins/_security/api/_upgrade_perform

https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade

Declaration

public Task<TResponse> ConfigUpgradePerformAsync<TResponse>(PostData body, ConfigUpgradePerformRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
ConfigUpgradePerformRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.14.0 or greater.

| Edit this page View Source

ConfigUpgradePerform<TResponse>(PostData, ConfigUpgradePerformRequestParameters)

POST on /_plugins/_security/api/_upgrade_perform

https://opensearch.org/docs/latest/security/access-control/api/#configuration-upgrade

Declaration

public TResponse ConfigUpgradePerform<TResponse>(PostData body, ConfigUpgradePerformRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
ConfigUpgradePerformRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.14.0 or greater.

| Edit this page View Source

CreateActionGroupAsync<TResponse>(string, PostData, CreateActionGroupRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#create-action-group

Declaration

public Task<TResponse> CreateActionGroupAsync<TResponse>(string actionGroup, PostData body, CreateActionGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to create or replace.
PostData	body
CreateActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateActionGroup<TResponse>(string, PostData, CreateActionGroupRequestParameters)

PUT on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#create-action-group

Declaration

public TResponse CreateActionGroup<TResponse>(string actionGroup, PostData body, CreateActionGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to create or replace.
PostData	body
CreateActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateAllowlistAsync<TResponse>(PostData, CreateAllowlistRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public Task<TResponse> CreateAllowlistAsync<TResponse>(PostData body, CreateAllowlistRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CreateAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

CreateAllowlist<TResponse>(PostData, CreateAllowlistRequestParameters)

PUT on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public TResponse CreateAllowlist<TResponse>(PostData body, CreateAllowlistRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CreateAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

CreateRoleAsync<TResponse>(string, PostData, CreateRoleRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#create-role

Declaration

public Task<TResponse> CreateRoleAsync<TResponse>(string role, PostData body, CreateRoleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to be created.
PostData	body
CreateRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateRoleMappingAsync<TResponse>(string, PostData, CreateRoleMappingRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping

Declaration

public Task<TResponse> CreateRoleMappingAsync<TResponse>(string role, PostData body, CreateRoleMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to create a role mapping for.
PostData	body
CreateRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateRoleMapping<TResponse>(string, PostData, CreateRoleMappingRequestParameters)

PUT on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#create-role-mapping

Declaration

public TResponse CreateRoleMapping<TResponse>(string role, PostData body, CreateRoleMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to create a role mapping for.
PostData	body
CreateRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateRole<TResponse>(string, PostData, CreateRoleRequestParameters)

PUT on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#create-role

Declaration

public TResponse CreateRole<TResponse>(string role, PostData body, CreateRoleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to be created.
PostData	body
CreateRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateTenantAsync<TResponse>(string, PostData, CreateTenantRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#create-tenant

Declaration

public Task<TResponse> CreateTenantAsync<TResponse>(string tenant, PostData body, CreateTenantRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to be created.
PostData	body
CreateTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateTenant<TResponse>(string, PostData, CreateTenantRequestParameters)

PUT on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#create-tenant

Declaration

public TResponse CreateTenant<TResponse>(string tenant, PostData body, CreateTenantRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to be created.
PostData	body
CreateTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateUpdateTenancyConfigAsync<TResponse>(PostData, CreateUpdateTenancyConfigRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/tenancy/config

https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api

Declaration

public Task<TResponse> CreateUpdateTenancyConfigAsync<TResponse>(PostData body, CreateUpdateTenancyConfigRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CreateUpdateTenancyConfigRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

CreateUpdateTenancyConfig<TResponse>(PostData, CreateUpdateTenancyConfigRequestParameters)

PUT on /_plugins/_security/api/tenancy/config

https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api

Declaration

public TResponse CreateUpdateTenancyConfig<TResponse>(PostData body, CreateUpdateTenancyConfigRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
CreateUpdateTenancyConfigRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

CreateUserAsync<TResponse>(string, PostData, CreateUserRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#create-user

Declaration

public Task<TResponse> CreateUserAsync<TResponse>(string username, PostData body, CreateUserRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to be created.
PostData	body
CreateUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateUserLegacyAsync<TResponse>(string, PostData, CreateUserLegacyRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/user/{username}

Declaration

public Task<TResponse> CreateUserLegacyAsync<TResponse>(string username, PostData body, CreateUserLegacyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to be created.
PostData	body
CreateUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateUserLegacy<TResponse>(string, PostData, CreateUserLegacyRequestParameters)

PUT on /_plugins/_security/api/user/{username}

Declaration

public TResponse CreateUserLegacy<TResponse>(string username, PostData body, CreateUserLegacyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to be created.
PostData	body
CreateUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

CreateUser<TResponse>(string, PostData, CreateUserRequestParameters)

PUT on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#create-user

Declaration

public TResponse CreateUser<TResponse>(string username, PostData body, CreateUserRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to be created.
PostData	body
CreateUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteActionGroupAsync<TResponse>(string, DeleteActionGroupRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group

Declaration

public Task<TResponse> DeleteActionGroupAsync<TResponse>(string actionGroup, DeleteActionGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to delete.
DeleteActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteActionGroup<TResponse>(string, DeleteActionGroupRequestParameters)

DELETE on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group

Declaration

public TResponse DeleteActionGroup<TResponse>(string actionGroup, DeleteActionGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to delete.
DeleteActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteDistinguishedNameAsync<TResponse>(string, DeleteDistinguishedNameRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names

Declaration

public Task<TResponse> DeleteDistinguishedNameAsync<TResponse>(string clusterName, DeleteDistinguishedNameRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to delete from list of distinguished names.
DeleteDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteDistinguishedName<TResponse>(string, DeleteDistinguishedNameRequestParameters)

DELETE on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#delete-distinguished-names

Declaration

public TResponse DeleteDistinguishedName<TResponse>(string clusterName, DeleteDistinguishedNameRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to delete from list of distinguished names.
DeleteDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRoleAsync<TResponse>(string, DeleteRoleRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#delete-role

Declaration

public Task<TResponse> DeleteRoleAsync<TResponse>(string role, DeleteRoleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to delete.
DeleteRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRoleMappingAsync<TResponse>(string, DeleteRoleMappingRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping

Declaration

public Task<TResponse> DeleteRoleMappingAsync<TResponse>(string role, DeleteRoleMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role whose mapping needs to delete.
DeleteRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRoleMapping<TResponse>(string, DeleteRoleMappingRequestParameters)

DELETE on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#delete-role-mapping

Declaration

public TResponse DeleteRoleMapping<TResponse>(string role, DeleteRoleMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role whose mapping needs to delete.
DeleteRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteRole<TResponse>(string, DeleteRoleRequestParameters)

DELETE on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#delete-role

Declaration

public TResponse DeleteRole<TResponse>(string role, DeleteRoleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to delete.
DeleteRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteTenantAsync<TResponse>(string, DeleteTenantRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group

Declaration

public Task<TResponse> DeleteTenantAsync<TResponse>(string tenant, DeleteTenantRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to delete.
DeleteTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteTenant<TResponse>(string, DeleteTenantRequestParameters)

DELETE on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#delete-action-group

Declaration

public TResponse DeleteTenant<TResponse>(string tenant, DeleteTenantRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to delete.
DeleteTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteUserAsync<TResponse>(string, DeleteUserRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#delete-user

Declaration

public Task<TResponse> DeleteUserAsync<TResponse>(string username, DeleteUserRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to delete.
DeleteUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteUserLegacyAsync<TResponse>(string, DeleteUserLegacyRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/user/{username}

Declaration

public Task<TResponse> DeleteUserLegacyAsync<TResponse>(string username, DeleteUserLegacyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to delete.
DeleteUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteUserLegacy<TResponse>(string, DeleteUserLegacyRequestParameters)

DELETE on /_plugins/_security/api/user/{username}

Declaration

public TResponse DeleteUserLegacy<TResponse>(string username, DeleteUserLegacyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to delete.
DeleteUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

DeleteUser<TResponse>(string, DeleteUserRequestParameters)

DELETE on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#delete-user

Declaration

public TResponse DeleteUser<TResponse>(string username, DeleteUserRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to delete.
DeleteUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

FlushCacheAsync<TResponse>(FlushCacheRequestParameters, CancellationToken)

DELETE on /_plugins/_security/api/cache

https://opensearch.org/docs/latest/security/access-control/api/#flush-cache

Declaration

public Task<TResponse> FlushCacheAsync<TResponse>(FlushCacheRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FlushCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

FlushCache<TResponse>(FlushCacheRequestParameters)

DELETE on /_plugins/_security/api/cache

https://opensearch.org/docs/latest/security/access-control/api/#flush-cache

Declaration

public TResponse FlushCache<TResponse>(FlushCacheRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
FlushCacheRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GenerateOboTokenAsync<TResponse>(PostData, GenerateOboTokenRequestParameters, CancellationToken)

POST on /_plugins/_security/api/generateonbehalfoftoken

https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint

Declaration

public Task<TResponse> GenerateOboTokenAsync<TResponse>(PostData body, GenerateOboTokenRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GenerateOboTokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

| Edit this page View Source

GenerateOboToken<TResponse>(PostData, GenerateOboTokenRequestParameters)

POST on /_plugins/_security/api/generateonbehalfoftoken

https://opensearch.org/docs/latest/security/access-control/authentication-tokens/#api-endpoint

Declaration

public TResponse GenerateOboToken<TResponse>(PostData body, GenerateOboTokenRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
GenerateOboTokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.12.0 or greater.

| Edit this page View Source

GenerateUserTokenAsync<TResponse>(string, GenerateUserTokenRequestParameters, CancellationToken)

POST on /_plugins/_security/api/internalusers/{username}/authtoken

Declaration

public Task<TResponse> GenerateUserTokenAsync<TResponse>(string username, GenerateUserTokenRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user for whom an auth token is to be vended.
GenerateUserTokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GenerateUserTokenLegacyAsync<TResponse>(string, GenerateUserTokenLegacyRequestParameters, CancellationToken)

POST on /_plugins/_security/api/user/{username}/authtoken

Declaration

public Task<TResponse> GenerateUserTokenLegacyAsync<TResponse>(string username, GenerateUserTokenLegacyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user for whom an auth token is to be vended.
GenerateUserTokenLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GenerateUserTokenLegacy<TResponse>(string, GenerateUserTokenLegacyRequestParameters)

POST on /_plugins/_security/api/user/{username}/authtoken

Declaration

public TResponse GenerateUserTokenLegacy<TResponse>(string username, GenerateUserTokenLegacyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user for whom an auth token is to be vended.
GenerateUserTokenLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GenerateUserToken<TResponse>(string, GenerateUserTokenRequestParameters)

POST on /_plugins/_security/api/internalusers/{username}/authtoken

Declaration

public TResponse GenerateUserToken<TResponse>(string username, GenerateUserTokenRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user for whom an auth token is to be vended.
GenerateUserTokenRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GetAccountDetailsAsync<TResponse>(GetAccountDetailsRequestParameters, CancellationToken)

GET on /_plugins/_security/api/account

https://opensearch.org/docs/latest/security/access-control/api/#get-account-details

Declaration

public Task<TResponse> GetAccountDetailsAsync<TResponse>(GetAccountDetailsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAccountDetailsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetAccountDetails<TResponse>(GetAccountDetailsRequestParameters)

GET on /_plugins/_security/api/account

https://opensearch.org/docs/latest/security/access-control/api/#get-account-details

Declaration

public TResponse GetAccountDetails<TResponse>(GetAccountDetailsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAccountDetailsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetActionGroupAsync<TResponse>(string, GetActionGroupRequestParameters, CancellationToken)

GET on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#get-action-group

Declaration

public Task<TResponse> GetActionGroupAsync<TResponse>(string actionGroup, GetActionGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to retrieve.
GetActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetActionGroup<TResponse>(string, GetActionGroupRequestParameters)

GET on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#get-action-group

Declaration

public TResponse GetActionGroup<TResponse>(string actionGroup, GetActionGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to retrieve.
GetActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetActionGroupsAsync<TResponse>(GetActionGroupsRequestParameters, CancellationToken)

GET on /_plugins/_security/api/actiongroups

https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups

Declaration

public Task<TResponse> GetActionGroupsAsync<TResponse>(GetActionGroupsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetActionGroupsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetActionGroups<TResponse>(GetActionGroupsRequestParameters)

GET on /_plugins/_security/api/actiongroups

https://opensearch.org/docs/latest/security/access-control/api/#get-action-groups

Declaration

public TResponse GetActionGroups<TResponse>(GetActionGroupsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetActionGroupsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetAllCertificatesAsync<TResponse>(GetAllCertificatesRequestParameters, CancellationToken)

GET on /_plugins/_security/api/certificates

Declaration

public Task<TResponse> GetAllCertificatesAsync<TResponse>(GetAllCertificatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAllCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.15.0 or greater.

| Edit this page View Source

GetAllCertificates<TResponse>(GetAllCertificatesRequestParameters)

GET on /_plugins/_security/api/certificates

Declaration

public TResponse GetAllCertificates<TResponse>(GetAllCertificatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAllCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.15.0 or greater.

| Edit this page View Source

GetAllowlistAsync<TResponse>(GetAllowlistRequestParameters, CancellationToken)

GET on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public Task<TResponse> GetAllowlistAsync<TResponse>(GetAllowlistRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetAllowlist<TResponse>(GetAllowlistRequestParameters)

GET on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public TResponse GetAllowlist<TResponse>(GetAllowlistRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

GetAuditConfigurationAsync<TResponse>(GetAuditConfigurationRequestParameters, CancellationToken)

GET on /_plugins/_security/api/audit

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public Task<TResponse> GetAuditConfigurationAsync<TResponse>(GetAuditConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetAuditConfiguration<TResponse>(GetAuditConfigurationRequestParameters)

GET on /_plugins/_security/api/audit

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public TResponse GetAuditConfiguration<TResponse>(GetAuditConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetCertificatesAsync<TResponse>(GetCertificatesRequestParameters, CancellationToken)

GET on /_plugins/_security/api/ssl/certs

https://opensearch.org/docs/latest/security/access-control/api/#get-certificates

Declaration

public Task<TResponse> GetCertificatesAsync<TResponse>(GetCertificatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

GetCertificates<TResponse>(GetCertificatesRequestParameters)

GET on /_plugins/_security/api/ssl/certs

https://opensearch.org/docs/latest/security/access-control/api/#get-certificates

Declaration

public TResponse GetCertificates<TResponse>(GetCertificatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

GetConfigurationAsync<TResponse>(GetConfigurationRequestParameters, CancellationToken)

GET on /_plugins/_security/api/securityconfig

https://opensearch.org/docs/latest/security/access-control/api/#get-configuration

Declaration

public Task<TResponse> GetConfigurationAsync<TResponse>(GetConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

GetConfiguration<TResponse>(GetConfigurationRequestParameters)

GET on /_plugins/_security/api/securityconfig

https://opensearch.org/docs/latest/security/access-control/api/#get-configuration

Declaration

public TResponse GetConfiguration<TResponse>(GetConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

GetDashboardsInfoAsync<TResponse>(GetDashboardsInfoRequestParameters, CancellationToken)

GET on /_plugins/_security/dashboardsinfo

Declaration

public Task<TResponse> GetDashboardsInfoAsync<TResponse>(GetDashboardsInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDashboardsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDashboardsInfo<TResponse>(GetDashboardsInfoRequestParameters)

GET on /_plugins/_security/dashboardsinfo

Declaration

public TResponse GetDashboardsInfo<TResponse>(GetDashboardsInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDashboardsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDistinguishedNameAsync<TResponse>(string, GetDistinguishedNameRequestParameters, CancellationToken)

GET on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names

Declaration

public Task<TResponse> GetDistinguishedNameAsync<TResponse>(string clusterName, GetDistinguishedNameRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to retrieve nodes DN setting for.
GetDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDistinguishedName<TResponse>(string, GetDistinguishedNameRequestParameters)

GET on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names

Declaration

public TResponse GetDistinguishedName<TResponse>(string clusterName, GetDistinguishedNameRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to retrieve nodes DN setting for.
GetDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDistinguishedNamesAsync<TResponse>(GetDistinguishedNamesRequestParameters, CancellationToken)

GET on /_plugins/_security/api/nodesdn

https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names

Declaration

public Task<TResponse> GetDistinguishedNamesAsync<TResponse>(GetDistinguishedNamesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDistinguishedNamesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetDistinguishedNames<TResponse>(GetDistinguishedNamesRequestParameters)

GET on /_plugins/_security/api/nodesdn

https://opensearch.org/docs/latest/security/access-control/api/#get-distinguished-names

Declaration

public TResponse GetDistinguishedNames<TResponse>(GetDistinguishedNamesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetDistinguishedNamesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetNodeCertificatesAsync<TResponse>(string, GetNodeCertificatesRequestParameters, CancellationToken)

GET on /_plugins/_security/api/certificates/{node_id}

Declaration

public Task<TResponse> GetNodeCertificatesAsync<TResponse>(string nodeId, GetNodeCertificatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	The full-id of the node to retrieve certificates.
GetNodeCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.15.0 or greater.

| Edit this page View Source

GetNodeCertificates<TResponse>(string, GetNodeCertificatesRequestParameters)

GET on /_plugins/_security/api/certificates/{node_id}

Declaration

public TResponse GetNodeCertificates<TResponse>(string nodeId, GetNodeCertificatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	nodeId	The full-id of the node to retrieve certificates.
GetNodeCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.15.0 or greater.

| Edit this page View Source

GetPermissionsInfoAsync<TResponse>(GetPermissionsInfoRequestParameters, CancellationToken)

GET on /_plugins/_security/api/permissionsinfo

Declaration

public Task<TResponse> GetPermissionsInfoAsync<TResponse>(GetPermissionsInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetPermissionsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetPermissionsInfo<TResponse>(GetPermissionsInfoRequestParameters)

GET on /_plugins/_security/api/permissionsinfo

Declaration

public TResponse GetPermissionsInfo<TResponse>(GetPermissionsInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetPermissionsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoleAsync<TResponse>(string, GetRoleRequestParameters, CancellationToken)

GET on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#get-role

Declaration

public Task<TResponse> GetRoleAsync<TResponse>(string role, GetRoleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role
GetRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoleMappingAsync<TResponse>(string, GetRoleMappingRequestParameters, CancellationToken)

GET on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping

Declaration

public Task<TResponse> GetRoleMappingAsync<TResponse>(string role, GetRoleMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role
GetRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoleMapping<TResponse>(string, GetRoleMappingRequestParameters)

GET on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#get-role-mapping

Declaration

public TResponse GetRoleMapping<TResponse>(string role, GetRoleMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role
GetRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoleMappingsAsync<TResponse>(GetRoleMappingsRequestParameters, CancellationToken)

GET on /_plugins/_security/api/rolesmapping

https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings

Declaration

public Task<TResponse> GetRoleMappingsAsync<TResponse>(GetRoleMappingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRoleMappingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoleMappings<TResponse>(GetRoleMappingsRequestParameters)

GET on /_plugins/_security/api/rolesmapping

https://opensearch.org/docs/latest/security/access-control/api/#get-role-mappings

Declaration

public TResponse GetRoleMappings<TResponse>(GetRoleMappingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRoleMappingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRole<TResponse>(string, GetRoleRequestParameters)

GET on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#get-role

Declaration

public TResponse GetRole<TResponse>(string role, GetRoleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role
GetRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRolesAsync<TResponse>(GetRolesRequestParameters, CancellationToken)

GET on /_plugins/_security/api/roles

https://opensearch.org/docs/latest/security/access-control/api/#get-roles

Declaration

public Task<TResponse> GetRolesAsync<TResponse>(GetRolesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRolesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetRoles<TResponse>(GetRolesRequestParameters)

GET on /_plugins/_security/api/roles

https://opensearch.org/docs/latest/security/access-control/api/#get-roles

Declaration

public TResponse GetRoles<TResponse>(GetRolesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetRolesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetSslinfoAsync<TResponse>(GetSslinfoRequestParameters, CancellationToken)

GET on /_opendistro/_security/sslinfo

Declaration

public Task<TResponse> GetSslinfoAsync<TResponse>(GetSslinfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetSslinfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetSslinfo<TResponse>(GetSslinfoRequestParameters)

GET on /_opendistro/_security/sslinfo

Declaration

public TResponse GetSslinfo<TResponse>(GetSslinfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetSslinfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetTenancyConfigAsync<TResponse>(GetTenancyConfigRequestParameters, CancellationToken)

GET on /_plugins/_security/api/tenancy/config

https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api

Declaration

public Task<TResponse> GetTenancyConfigAsync<TResponse>(GetTenancyConfigRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetTenancyConfigRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GetTenancyConfig<TResponse>(GetTenancyConfigRequestParameters)

GET on /_plugins/_security/api/tenancy/config

https://opensearch.org/docs/latest/security/multi-tenancy/dynamic-config/#configuring-multi-tenancy-with-the-rest-api

Declaration

public TResponse GetTenancyConfig<TResponse>(GetTenancyConfigRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetTenancyConfigRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.7.0 or greater.

| Edit this page View Source

GetTenantAsync<TResponse>(string, GetTenantRequestParameters, CancellationToken)

GET on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#get-tenant

Declaration

public Task<TResponse> GetTenantAsync<TResponse>(string tenant, GetTenantRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to retrieve.
GetTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetTenant<TResponse>(string, GetTenantRequestParameters)

GET on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#get-tenant

Declaration

public TResponse GetTenant<TResponse>(string tenant, GetTenantRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to retrieve.
GetTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetTenantsAsync<TResponse>(GetTenantsRequestParameters, CancellationToken)

GET on /_plugins/_security/api/tenants

https://opensearch.org/docs/latest/security/access-control/api/#get-tenants

Declaration

public Task<TResponse> GetTenantsAsync<TResponse>(GetTenantsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetTenantsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetTenants<TResponse>(GetTenantsRequestParameters)

GET on /_plugins/_security/api/tenants

https://opensearch.org/docs/latest/security/access-control/api/#get-tenants

Declaration

public TResponse GetTenants<TResponse>(GetTenantsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetTenantsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUserAsync<TResponse>(string, GetUserRequestParameters, CancellationToken)

GET on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#get-user

Declaration

public Task<TResponse> GetUserAsync<TResponse>(string username, GetUserRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to retrieve.
GetUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUserLegacyAsync<TResponse>(string, GetUserLegacyRequestParameters, CancellationToken)

GET on /_plugins/_security/api/user/{username}

Declaration

public Task<TResponse> GetUserLegacyAsync<TResponse>(string username, GetUserLegacyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to retrieve.
GetUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUserLegacy<TResponse>(string, GetUserLegacyRequestParameters)

GET on /_plugins/_security/api/user/{username}

Declaration

public TResponse GetUserLegacy<TResponse>(string username, GetUserLegacyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to retrieve.
GetUserLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUser<TResponse>(string, GetUserRequestParameters)

GET on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#get-user

Declaration

public TResponse GetUser<TResponse>(string username, GetUserRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to retrieve.
GetUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUsersAsync<TResponse>(GetUsersRequestParameters, CancellationToken)

GET on /_plugins/_security/api/internalusers

https://opensearch.org/docs/latest/security/access-control/api/#get-users

Declaration

public Task<TResponse> GetUsersAsync<TResponse>(GetUsersRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUsersRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUsersLegacyAsync<TResponse>(GetUsersLegacyRequestParameters, CancellationToken)

GET on /_plugins/_security/api/user

Declaration

public Task<TResponse> GetUsersLegacyAsync<TResponse>(GetUsersLegacyRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUsersLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUsersLegacy<TResponse>(GetUsersLegacyRequestParameters)

GET on /_plugins/_security/api/user

Declaration

public TResponse GetUsersLegacy<TResponse>(GetUsersLegacyRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUsersLegacyRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

GetUsers<TResponse>(GetUsersRequestParameters)

GET on /_plugins/_security/api/internalusers

https://opensearch.org/docs/latest/security/access-control/api/#get-users

Declaration

public TResponse GetUsers<TResponse>(GetUsersRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
GetUsersRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

HealthAsync<TResponse>(HealthRequestParameters, CancellationToken)

POST on /_plugins/_security/health

https://opensearch.org/docs/latest/security/access-control/api/#health-check

Declaration

public Task<TResponse> HealthAsync<TResponse>(HealthRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Health<TResponse>(HealthRequestParameters)

POST on /_plugins/_security/health

https://opensearch.org/docs/latest/security/access-control/api/#health-check

Declaration

public TResponse Health<TResponse>(HealthRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
HealthRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

MigrateAsync<TResponse>(MigrateRequestParameters, CancellationToken)

POST on /_plugins/_security/api/migrate

Declaration

public Task<TResponse> MigrateAsync<TResponse>(MigrateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
MigrateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Migrate<TResponse>(MigrateRequestParameters)

POST on /_plugins/_security/api/migrate

Declaration

public TResponse Migrate<TResponse>(MigrateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
MigrateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchActionGroupAsync<TResponse>(string, PostData, PatchActionGroupRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group

Declaration

public Task<TResponse> PatchActionGroupAsync<TResponse>(string actionGroup, PostData body, PatchActionGroupRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to update.
PostData	body
PatchActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchActionGroup<TResponse>(string, PostData, PatchActionGroupRequestParameters)

PATCH on /_plugins/_security/api/actiongroups/{action_group}

https://opensearch.org/docs/latest/security/access-control/api/#patch-action-group

Declaration

public TResponse PatchActionGroup<TResponse>(string actionGroup, PostData body, PatchActionGroupRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	actionGroup	The name of the action group to update.
PostData	body
PatchActionGroupRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchActionGroupsAsync<TResponse>(PostData, PatchActionGroupsRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/actiongroups

https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups

Declaration

public Task<TResponse> PatchActionGroupsAsync<TResponse>(PostData body, PatchActionGroupsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchActionGroupsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchActionGroups<TResponse>(PostData, PatchActionGroupsRequestParameters)

PATCH on /_plugins/_security/api/actiongroups

https://opensearch.org/docs/latest/security/access-control/api/#patch-action-groups

Declaration

public TResponse PatchActionGroups<TResponse>(PostData body, PatchActionGroupsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchActionGroupsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchAllowlistAsync<TResponse>(PostData, PatchAllowlistRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public Task<TResponse> PatchAllowlistAsync<TResponse>(PostData body, PatchAllowlistRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

PatchAllowlist<TResponse>(PostData, PatchAllowlistRequestParameters)

PATCH on /_plugins/_security/api/allowlist

https://opensearch.org/docs/latest/security/access-control/api/#access-control-for-the-api

Declaration

public TResponse PatchAllowlist<TResponse>(PostData body, PatchAllowlistRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchAllowlistRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.1.0 or greater.

| Edit this page View Source

PatchAuditConfigurationAsync<TResponse>(PostData, PatchAuditConfigurationRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/audit

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public Task<TResponse> PatchAuditConfigurationAsync<TResponse>(PostData body, PatchAuditConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchAuditConfiguration<TResponse>(PostData, PatchAuditConfigurationRequestParameters)

PATCH on /_plugins/_security/api/audit

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public TResponse PatchAuditConfiguration<TResponse>(PostData body, PatchAuditConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchConfigurationAsync<TResponse>(PostData, PatchConfigurationRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/securityconfig

https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration

Declaration

public Task<TResponse> PatchConfigurationAsync<TResponse>(PostData body, PatchConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

PatchConfiguration<TResponse>(PostData, PatchConfigurationRequestParameters)

PATCH on /_plugins/_security/api/securityconfig

https://opensearch.org/docs/latest/security/access-control/api/#patch-configuration

Declaration

public TResponse PatchConfiguration<TResponse>(PostData body, PatchConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

PatchDistinguishedNameAsync<TResponse>(string, PostData, PatchDistinguishedNameRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/nodesdn/{cluster_name}

Declaration

public Task<TResponse> PatchDistinguishedNameAsync<TResponse>(string clusterName, PostData body, PatchDistinguishedNameRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster name to update `nodesDn` value.
PostData	body
PatchDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchDistinguishedName<TResponse>(string, PostData, PatchDistinguishedNameRequestParameters)

PATCH on /_plugins/_security/api/nodesdn/{cluster_name}

Declaration

public TResponse PatchDistinguishedName<TResponse>(string clusterName, PostData body, PatchDistinguishedNameRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster name to update `nodesDn` value.
PostData	body
PatchDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchDistinguishedNamesAsync<TResponse>(PostData, PatchDistinguishedNamesRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/nodesdn

https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names

Declaration

public Task<TResponse> PatchDistinguishedNamesAsync<TResponse>(PostData body, PatchDistinguishedNamesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchDistinguishedNamesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchDistinguishedNames<TResponse>(PostData, PatchDistinguishedNamesRequestParameters)

PATCH on /_plugins/_security/api/nodesdn

https://opensearch.org/docs/latest/security/access-control/api/#update-all-distinguished-names

Declaration

public TResponse PatchDistinguishedNames<TResponse>(PostData body, PatchDistinguishedNamesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchDistinguishedNamesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoleAsync<TResponse>(string, PostData, PatchRoleRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#patch-role

Declaration

public Task<TResponse> PatchRoleAsync<TResponse>(string role, PostData body, PatchRoleRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to update.
PostData	body
PatchRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoleMappingAsync<TResponse>(string, PostData, PatchRoleMappingRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping

Declaration

public Task<TResponse> PatchRoleMappingAsync<TResponse>(string role, PostData body, PatchRoleMappingRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to update role-mapping for.
PostData	body
PatchRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoleMapping<TResponse>(string, PostData, PatchRoleMappingRequestParameters)

PATCH on /_plugins/_security/api/rolesmapping/{role}

https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mapping

Declaration

public TResponse PatchRoleMapping<TResponse>(string role, PostData body, PatchRoleMappingRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to update role-mapping for.
PostData	body
PatchRoleMappingRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoleMappingsAsync<TResponse>(PostData, PatchRoleMappingsRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/rolesmapping

https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings

Declaration

public Task<TResponse> PatchRoleMappingsAsync<TResponse>(PostData body, PatchRoleMappingsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchRoleMappingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoleMappings<TResponse>(PostData, PatchRoleMappingsRequestParameters)

PATCH on /_plugins/_security/api/rolesmapping

https://opensearch.org/docs/latest/security/access-control/api/#patch-role-mappings

Declaration

public TResponse PatchRoleMappings<TResponse>(PostData body, PatchRoleMappingsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchRoleMappingsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRole<TResponse>(string, PostData, PatchRoleRequestParameters)

PATCH on /_plugins/_security/api/roles/{role}

https://opensearch.org/docs/latest/security/access-control/api/#patch-role

Declaration

public TResponse PatchRole<TResponse>(string role, PostData body, PatchRoleRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	role	The name of the role to update.
PostData	body
PatchRoleRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRolesAsync<TResponse>(PostData, PatchRolesRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/roles

https://opensearch.org/docs/latest/security/access-control/api/#patch-roles

Declaration

public Task<TResponse> PatchRolesAsync<TResponse>(PostData body, PatchRolesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchRolesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchRoles<TResponse>(PostData, PatchRolesRequestParameters)

PATCH on /_plugins/_security/api/roles

https://opensearch.org/docs/latest/security/access-control/api/#patch-roles

Declaration

public TResponse PatchRoles<TResponse>(PostData body, PatchRolesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchRolesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchTenantAsync<TResponse>(string, PostData, PatchTenantRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant

Declaration

public Task<TResponse> PatchTenantAsync<TResponse>(string tenant, PostData body, PatchTenantRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to update.
PostData	body
PatchTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchTenant<TResponse>(string, PostData, PatchTenantRequestParameters)

PATCH on /_plugins/_security/api/tenants/{tenant}

https://opensearch.org/docs/latest/security/access-control/api/#patch-tenant

Declaration

public TResponse PatchTenant<TResponse>(string tenant, PostData body, PatchTenantRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	tenant	The name of the tenant to update.
PostData	body
PatchTenantRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchTenantsAsync<TResponse>(PostData, PatchTenantsRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/tenants

https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants

Declaration

public Task<TResponse> PatchTenantsAsync<TResponse>(PostData body, PatchTenantsRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchTenantsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchTenants<TResponse>(PostData, PatchTenantsRequestParameters)

PATCH on /_plugins/_security/api/tenants

https://opensearch.org/docs/latest/security/access-control/api/#patch-tenants

Declaration

public TResponse PatchTenants<TResponse>(PostData body, PatchTenantsRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchTenantsRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchUserAsync<TResponse>(string, PostData, PatchUserRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#patch-user

Declaration

public Task<TResponse> PatchUserAsync<TResponse>(string username, PostData body, PatchUserRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to update.
PostData	body
PatchUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchUser<TResponse>(string, PostData, PatchUserRequestParameters)

PATCH on /_plugins/_security/api/internalusers/{username}

https://opensearch.org/docs/latest/security/access-control/api/#patch-user

Declaration

public TResponse PatchUser<TResponse>(string username, PostData body, PatchUserRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	username	The name of the user to update.
PostData	body
PatchUserRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchUsersAsync<TResponse>(PostData, PatchUsersRequestParameters, CancellationToken)

PATCH on /_plugins/_security/api/internalusers

https://opensearch.org/docs/latest/security/access-control/api/#patch-users

Declaration

public Task<TResponse> PatchUsersAsync<TResponse>(PostData body, PatchUsersRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchUsersRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PatchUsers<TResponse>(PostData, PatchUsersRequestParameters)

PATCH on /_plugins/_security/api/internalusers

https://opensearch.org/docs/latest/security/access-control/api/#patch-users

Declaration

public TResponse PatchUsers<TResponse>(PostData body, PatchUsersRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
PatchUsersRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PostDashboardsInfoAsync<TResponse>(PostDashboardsInfoRequestParameters, CancellationToken)

POST on /_plugins/_security/dashboardsinfo

Declaration

public Task<TResponse> PostDashboardsInfoAsync<TResponse>(PostDashboardsInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostDashboardsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

PostDashboardsInfo<TResponse>(PostDashboardsInfoRequestParameters)

POST on /_plugins/_security/dashboardsinfo

Declaration

public TResponse PostDashboardsInfo<TResponse>(PostDashboardsInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostDashboardsInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ReloadHttpCertificatesAsync<TResponse>(ReloadHttpCertificatesRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/ssl/http/reloadcerts

https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates

Declaration

public Task<TResponse> ReloadHttpCertificatesAsync<TResponse>(ReloadHttpCertificatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ReloadHttpCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.8.0 or greater.

| Edit this page View Source

ReloadHttpCertificates<TResponse>(ReloadHttpCertificatesRequestParameters)

PUT on /_plugins/_security/api/ssl/http/reloadcerts

https://opensearch.org/docs/latest/security/access-control/api/#reload-http-certificates

Declaration

public TResponse ReloadHttpCertificates<TResponse>(ReloadHttpCertificatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ReloadHttpCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.8.0 or greater.

| Edit this page View Source

ReloadTransportCertificatesAsync<TResponse>(ReloadTransportCertificatesRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/ssl/transport/reloadcerts

https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates

Declaration

public Task<TResponse> ReloadTransportCertificatesAsync<TResponse>(ReloadTransportCertificatesRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ReloadTransportCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.8.0 or greater.

| Edit this page View Source

ReloadTransportCertificates<TResponse>(ReloadTransportCertificatesRequestParameters)

PUT on /_plugins/_security/api/ssl/transport/reloadcerts

https://opensearch.org/docs/latest/security/access-control/api/#reload-transport-certificates

Declaration

public TResponse ReloadTransportCertificates<TResponse>(ReloadTransportCertificatesRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ReloadTransportCertificatesRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.8.0 or greater.

| Edit this page View Source

TenantInfoAsync<TResponse>(TenantInfoRequestParameters, CancellationToken)

POST on /_plugins/_security/tenantinfo

Declaration

public Task<TResponse> TenantInfoAsync<TResponse>(TenantInfoRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
TenantInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

TenantInfo<TResponse>(TenantInfoRequestParameters)

POST on /_plugins/_security/tenantinfo

Declaration

public TResponse TenantInfo<TResponse>(TenantInfoRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
TenantInfoRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

UpdateAuditConfigurationAsync<TResponse>(PostData, UpdateAuditConfigurationRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/audit/config

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public Task<TResponse> UpdateAuditConfigurationAsync<TResponse>(PostData body, UpdateAuditConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
UpdateAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

UpdateAuditConfiguration<TResponse>(PostData, UpdateAuditConfigurationRequestParameters)

PUT on /_plugins/_security/api/audit/config

https://opensearch.org/docs/latest/security/access-control/api/#audit-logs

Declaration

public TResponse UpdateAuditConfiguration<TResponse>(PostData body, UpdateAuditConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
UpdateAuditConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

UpdateConfigurationAsync<TResponse>(PostData, UpdateConfigurationRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/securityconfig/config

https://opensearch.org/docs/latest/security/access-control/api/#update-configuration

Declaration

public Task<TResponse> UpdateConfigurationAsync<TResponse>(PostData body, UpdateConfigurationRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
UpdateConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

UpdateConfiguration<TResponse>(PostData, UpdateConfigurationRequestParameters)

PUT on /_plugins/_security/api/securityconfig/config

https://opensearch.org/docs/latest/security/access-control/api/#update-configuration

Declaration

public TResponse UpdateConfiguration<TResponse>(PostData body, UpdateConfigurationRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
PostData	body
UpdateConfigurationRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.10.0 or greater.

| Edit this page View Source

UpdateDistinguishedNameAsync<TResponse>(string, PostData, UpdateDistinguishedNameRequestParameters, CancellationToken)

PUT on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names

Declaration

public Task<TResponse> UpdateDistinguishedNameAsync<TResponse>(string clusterName, PostData body, UpdateDistinguishedNameRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to create/update `nodesDn` value for.
PostData	body
UpdateDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

UpdateDistinguishedName<TResponse>(string, PostData, UpdateDistinguishedNameRequestParameters)

PUT on /_plugins/_security/api/nodesdn/{cluster_name}

https://opensearch.org/docs/latest/security/access-control/api/#update-distinguished-names

Declaration

public TResponse UpdateDistinguishedName<TResponse>(string clusterName, PostData body, UpdateDistinguishedNameRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
string	clusterName	The cluster-name to create/update `nodesDn` value for.
PostData	body
UpdateDistinguishedNameRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

ValidateAsync<TResponse>(ValidateRequestParameters, CancellationToken)

GET on /_plugins/_security/api/validate

Declaration

public Task<TResponse> ValidateAsync<TResponse>(ValidateRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ValidateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

| Edit this page View Source

Validate<TResponse>(ValidateRequestParameters)

GET on /_plugins/_security/api/validate

Declaration

public TResponse Validate<TResponse>(ValidateRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
ValidateRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

| Edit this page View Source

WhoAmIAsync<TResponse>(WhoAmIRequestParameters, CancellationToken)

POST on /_plugins/_security/whoami

Declaration

public Task<TResponse> WhoAmIAsync<TResponse>(WhoAmIRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
WhoAmIRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

| Edit this page View Source

WhoAmIProtectedAsync<TResponse>(WhoAmIProtectedRequestParameters, CancellationToken)

GET on /_plugins/_security/whoamiprotected

Declaration

public Task<TResponse> WhoAmIProtectedAsync<TResponse>(WhoAmIProtectedRequestParameters requestParameters = null, CancellationToken ctx = default) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
WhoAmIProtectedRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.
CancellationToken	ctx

Returns

Type	Description
Task<TResponse>

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

WhoAmIProtected<TResponse>(WhoAmIProtectedRequestParameters)

GET on /_plugins/_security/whoamiprotected

Declaration

public TResponse WhoAmIProtected<TResponse>(WhoAmIProtectedRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
WhoAmIProtectedRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.11.0 or greater.

| Edit this page View Source

WhoAmI<TResponse>(WhoAmIRequestParameters)

POST on /_plugins/_security/whoami

Declaration

public TResponse WhoAmI<TResponse>(WhoAmIRequestParameters requestParameters = null) where TResponse : class, IOpenSearchResponse, new()

Parameters

Type	Name	Description
WhoAmIRequestParameters	requestParameters	Request specific configuration such as querystring parameters & request specific connection settings.

Returns

Type	Description
TResponse

Type Parameters

Name	Description
TResponse

Remarks

Supported by OpenSearch servers of version 2.0.0 or greater.

Extension Methods

SuffixExtensions.Suffix(object, string)