Generate App Group Credentials for Secure API Access - OpenSearch

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

opensearch:WriteAppGroupCredential

create

*AppGroupCredential

acs:opensearch:{#regionId}:{#accountId}:appGroup/{#AppGroupId}

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/credentials HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The identity of the application group.	app_group_123

Request parameters

Parameter	Type	Required	Description	Example
dryRun	boolean	No	Specifies whether to perform a dry run. In a dry run, the system checks the request parameters but does not execute the operation.
body	object	No	The request body, which contains information such as the credential type.
type	string	No	The credential type, such as `api-key`, `account`, `invoke-key`, or `api-token`. To create an API key, set this parameter to `api-token`.	api-token

Response elements

Element	Type	Description	Example
	object	The structure of a successful response.
requestId	string	The unique ID of the request.	1-2-3-4
result	object	The details of the operation result.
appGroupId	integer	The ID of the application group.	app_group_123
type	string	The credential type.	api-token
enabled	boolean	Indicates whether the credential is enabled.
token	string	The generated credential token.	generated_token_string

Examples

Success response

JSON format

{
  "requestId": "1-2-3-4",
  "result": {
    "appGroupId": 0,
    "type": "api-token",
    "enabled": false,
    "token": "generated_token_string"
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.