Querying the API Authentication Information of an Application

Function

This API is used to query the API authentication information of an application.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

GET /v1/{project_id}/services/{service_id}/app-auth-apis

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
service_id	Yes	String	Service ID
project_id	Yes	String	Definition: Project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
workspace_id	No	String	Definition: Workspace ID Constraints: If no workspaces are available, the default value is 0. If a workspace is created and used, use the actual value. For details about how to obtain the ID, see Querying the Workspace List. Range: N/A Default Value: N/A

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API that is used for obtaining a user token. The value of X-Subject-Token in the response header is the user token.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
apis	Array of AuthTypeApiBasicInfo objects	API authentication information list.
count	Integer	Number of records.
total_count	Integer	Total number of records.

**Table 5** AuthTypeApiBasicInfo
Parameter	Type	Description
api_id	String	API ID
api_method	String	Request method, which can be GET, POST, PUT, DELETE, HEAD, PATCH, OPTIONS, or ANY. ANY is the default value.
api_name	String	API name
api_remark	String	API description. The value contains a maximum of 255 characters.
auth_type	String	API authentication mode. The options are: Enums: NONE: no authentication APP: App authentication IAM: IAM authentication
predict_url	String	Prediction URL
service_id	String	Service ID
service_name	String	Service name
support_app_code	Boolean	Whether to support the App code

Example Requests

None

Example Responses

Status code: 200

{
  "apis" : [ {
    "api_id" : "528087f0cfec48f7959db7834ee441cb",
    "api_method" : "ANY",
    "api_name" : "testNoneAuth",
    "api_remark" : "string",
    "auth_type" : "APP",
    "predict_url" : "https://3565150c2e5c45d0989be40350dd80ed.apig.xxxxxx.com/test",
    "service_id" : "bb149aac-5ff4-497c-bb73-acb751e20a11",
    "service_name" : "service-hutest",
    "support_app_code" : false
  } ],
  "count" : 1,
  "total_count" : 1
}