Help Center> ROMA Connect> API Reference> Out-of-Date APIs> APIC APIs (V1)> Custom Authorizer Management (V1)> Querying Custom Authorizers
View PDF

Querying Custom Authorizers

Function

Querying Custom Authorizers

URI

GET /v1/{project_id}/apic/instances/{instance_id}/authorizers

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.
Table 2 Query parameters

Parameter

Mandatory

Type

Description

offset

No

Long

Offset from which the query starts. If the offset is less than 0, the value is automatically converted to 0.

Default: 0

limit

No

Integer

Number of items displayed on each page.

Minimum: 1

Maximum: 500

Default: 20

id

No

String

ID.

name

No

String

Name.

type

No

String

Type.

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 (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

size

Integer

Length of the returned resource list.

total

Long

Number of resources that match the query conditions.

authorizer_list

Array of AuthorizerResp objects

Custom authorizer list.
Table 5 AuthorizerResp

Parameter

Type

Description

name

String

Custom authorizer name. The value contains 3 to 64 characters, including letters, digits, and underscores (_). The value must start with a letter.

type

String

Custom authorizer type.

  • FRONTEND

  • BACKEND

authorizer_type

String

Type of the custom authentication function.

  • LD: custom backend function

  • FUNC: FunctionGraph function

authorizer_uri

String

Function URN.

Note: To use a custom backend function API, the API request method must be POST and the API status must be Deployed.

identities

Array of Identity objects

Authentication source.

ttl

Integer

Cache time.

user_data

String

User data.

ld_api_id

String

Custom backend service ID.

This parameter is mandatory when the type of the user-defined authentication function is LD.

need_body

Boolean

Indicates whether to send request body.

id

String

Custom authorizer ID.

create_time

String

Creation time.

roma_app_id

String

ID of the application to which the custom authorizer belongs.

roma_app_name

String

Name of the application to which the custom authorizer belongs.
Table 6 Identity

Parameter

Type

Description

name

String

Parameter name.

Minimum: 0

Maximum: 32

location

String

Parameter location.

validation

String

Parameter verification expression. The default value is null, indicating that no verification is performed.

Maximum: 1024

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 11 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "total" : 1,
  "size" : 1,
  "authorizer_list" : [ {
    "name" : "Authorizer_demo",
    "type" : "FRONTEND",
    "authorizer_type" : "LD",
    "authorizer_uri" : "/test",
    "identities" : [ {
      "name" : "header",
      "location" : "HEADER"
    } ],
    "ttl" : 5,
    "user_data" : "authorizer_test",
    "id" : "0d982c1ac3da493dae47627b6439fc5c",
    "create_time" : "2020-09-23T02:32:10Z",
    "need_body" : true,
    "roma_app_id" : "98df09fb-d459-4cbf-83a7-2b55ca6f3d5d",
    "roma_app_name" : "app-demo"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 404

Not Found

{
  "error_code" : "APIG.3030",
  "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620e"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.