DeleteGatewayAuth - Microservices Engine - Alibaba Cloud Documentation Center

Deletes gateway authentication.

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

mse:DeleteGatewayAuth

delete

*Gateway

acs:mse:{#regionId}:{#accountId}:instance/{#GatewayUniqueId}

None

Request parameters

Parameter	Type	Required	Description	Example
Id	integer	No	The authentication ID.	120
GatewayUniqueId	string	No	The unique ID of the gateway.	gw-e2d226bba4b2445c9e29fa7f8216****
		No	The language of the returned results. Valid values: zh (default): Chinese, en: English.	zh

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	316F5F64-F73D-42DC-8632-01E308B6****
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The returned message.	OK
Code	integer	The response code. The value is fixed to 200 when Success is true.	200
Success	boolean	Indicates whether the request was successful. Valid values: `true`: The request was successful. `false`: The request failed.	true
Data	object	The returned data.
Id	integer	The authentication ID.	120
Name	string	The authentication name.	test
GatewayUniqueId	string	The unique ID of the gateway.	gw-e2d226bba4b2445c9e29fa7f8216****
GatewayId	integer	The gateway ID.	399
Type	string	The authentication type. Valid values: JWT OIDC IDaaS ExternalAuthZ (self-managed authentication service)	JWT
Issuer	string	Used when the authentication type is JWT or OIDC: JWT: The iss (issuer) in JWT claims, which specifies the token issuer. OIDC: The iss (issuer) in OIDC claims, which specifies the token issuer.	https://example.com/auth
Jwks	string	The JWT public key in JSON format.	{ "keys": [ { "e": "AQAB", "kid": "DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ", "kty": "RSA", "n": "xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ" } ] }
IsWhite	boolean	The blacklist and whitelist mode for authorization. Valid values: true: whitelist mode. The hosts and paths in the list can be accessed without verification. All other requests require verification. false: blacklist mode. The hosts and paths in the list require verification. All other requests can be accessed directly.	true
GmtCreate	string	The creation time.	2022-01-07 18:07:57
GmtModified	string	The update time.	2022-01-07 18:07:57
TokenPosition	string	The JWT token position. Valid values: HEADER: Transmitted through the header. The token parameter to be verified. By default, the token is placed in the Authorization header with the Bearer prefix. Example: Authorization: Bearer token.	HEADER
TokenName	string	The name of the token parameter to be verified. By default, the token is placed in the Authorization header with the Bearer prefix. Example: `Authorization: Bearer token`.	Authorization
TokenNamePrefix	string	The prefix of the JWT token.	Bearer
TokenPass	boolean	Indicates whether the token is passed through.	true
Status	boolean	The enabled status. Valid values: false: Disabled. true: Enabled.	true
RedirectUrl	string	The redirect URL after successful authorization. Used for OIDC/IDaaS. This URL must be consistent with the redirect URL configured in OIDC/IDaaS.	https://yourdomain/path
ClientId	string	The application ID registered with the service. Used for OIDC/IDaaS.	example-app
ClientSecret	string	The application secret registered with the service. Used for OIDC/IDaaS.	xxxxx
CookieDomain	string	The cookie domain name. After authentication succeeds, the cookie is sent to the specified domain name to maintain the logon state. Used for OIDC/IDaaS.	test.com
ScopesList	array	The OIDC scopes. Used for OIDC.
	string	The OIDC scopes. Used for OIDC.	openid
LoginUrl	string	The logon page URL of the IDaaS instance. Used for IDaaS.	https://daxxxxcn.aliyunidaas.com/

Examples

Success response

JSON format

{
  "RequestId": "316F5F64-F73D-42DC-8632-01E308B6****",
  "HttpStatusCode": 200,
  "Message": "OK",
  "Code": 200,
  "Success": true,
  "Data": {
    "Id": 120,
    "Name": "test",
    "GatewayUniqueId": "gw-e2d226bba4b2445c9e29fa7f8216****",
    "GatewayId": 399,
    "Type": "JWT",
    "Issuer": "https://example.com/auth",
    "Jwks": "{\n      \"keys\": [\n            {\n                  \"e\": \"AQAB\",\n                  \"kid\": \"DHFbpoIUqrY8t2zpA2qXfCmr5VO5ZEr4RzHU_-envvQ\",\n                  \"kty\": \"RSA\",\n                  \"n\": \"xAE7eB6qugXyCAG3yhh7pkDkT65pHymX-P7KfIupjf59vsdo91bSP9C8H07pSAGQO1MV_xFj9VswgsCg4R6otmg5PV2He95lZdHtOcU5DXIg_pbhLdKXbi66GlVeK6ABZOUW3WYtnNHD-91gVuoeJT_DwtGGcp4ignkgXfkiEm4sw-4sfb4qdt5oLbyVpmW6x9cfa7vs2WTfURiCrBoUqgBo_-4WTiULmmHSGZHOjzwa8WtrtOQGsAFjIbno85jp6MnGGGZPYZbDAa_b3y5u-YpW7ypZrvD8BgtKVjgtQgZhLAGezMt0ua3DRrWnKqTZ0BJ_EyxOGuHJrLsn00fnMQ\"\n            }\n      ]\n}",
    "IsWhite": true,
    "GmtCreate": "2022-01-07 18:07:57",
    "GmtModified": "2022-01-07 18:07:57",
    "TokenPosition": "HEADER",
    "TokenName": "Authorization",
    "TokenNamePrefix": "Bearer ",
    "TokenPass": true,
    "Status": true,
    "RedirectUrl": "https://yourdomain/path",
    "ClientId": "example-app",
    "ClientSecret": "xxxxx",
    "CookieDomain": "test.com",
    "ScopesList": [
      "openid"
    ],
    "LoginUrl": "https://daxxxxcn.aliyunidaas.com/"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalRequest	Invalid request:%s	Invalid request: %s
400	InvalidParameter	Parameter error:%s	Request parameter error: %s
500	InternalError	Console error. Try again later:%s	Console error. Try again later: %s
403	NoPermission	You are not authorized to perform this operation:%s	You do not have the permission to use this interface:%s
404	NotFound	Not found:%s	The resource does not exist:%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.