Help Center/ ModelArts/ API Reference/ App Authentication Management/ Obtaining API Authorization Relationships
Updated on 2024-05-30 GMT+08:00

Obtaining API Authorization Relationships

Function

This API is used to obtain the authorization relationships between specified APIs and Apps. The API authentication mode must be App authentication. Administrators can obtain authorization information about all APIs. Common users can obtain only authorization information about APIs of services on which they have access permissions.

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/{api_id}/api-auths

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details, see Obtaining a Project ID and Name.

service_id

Yes

String

Service ID.

api_id

Yes

String

API ID

Table 2 Query Parameters

Parameter

Mandatory

Type

Description

limit

No

String

Number of items displayed on one page. The default value is 1000.

offset

No

String

Sequence number of the page from which data is displayed on multiple pages. The default value is 0.

app_name

No

String

App name. Fuzzy search is supported.

order

No

String

Sorting mode of the returned App list. The value can be asc and desc. The default value is asc.

show_only

No

String

App information. Enums:

  • AUTH: Only information about authorized Apps is displayed.

  • UNAUTH: Only information about unauthorized Apps is displayed. By default, this parameter is left blank, indicating that information about all visible Apps is displayed.

sort_by

No

String

Sorting field of the returned App list. Enums:

  • app_name: application name

  • created_at: application creation time

  • updated_at: application update time The default value is app_name.

workspace_id

No

String

Workspace ID.

iphertext_enabled

No

Boolean

Whether to display the AppSecret in plaintext.

app_ids

No

Array

App IDs to be displayed in plaintext.

Request Parameters

None

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

auths

Array of ApiAuthInfo objects

Authorization array

count

Integer

Number of queried authorizations

total_count

Integer

Total number of authorizations

Table 4 ApiAuthInfo

Parameter

Type

Description

app

ApigAppDetailInfo object

App information

authed

Boolean

Whether the API has been authorized to the app

Table 5 ApigAppDetailInfo

Parameter

Type

Description

app_codes

Array of strings

App code list. When app_type is APIC, this parameter is left blank.

app_id

String

App ID

app_key

String

App key

app_name

String

App name

app_remark

String

App description, which is left blank by default. The value contains a maximum of 200 characters.

app_secret

String

App secret key

app_type

String

App type. Enums:

  • APIC: This App is registered with the ROMA Connect gateway.

  • APIG: This App is registered with the shared API gateway.

  • DEDICATE_APIG: This App is registered with the dedicated API gateway.

bounded_api_count

Integer

Number of APIs bound to the app

created_at

Long

Time when an app is created

project_id

String

Project ID

updated_at

Long

App update time

user_id

String

ID of the user who creates the app

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error codes of ModelArts.

error_msg

String

Error message.

Example Requests

GET https://{endpoint}/v1/{project_id}/services/{service_id}/app-auth-apis/{api_id}/api-auths

Example Responses

Status code: 200

OK

{
  "auths" : [ {
    "app" : {
      "app_id" : "fb1a9eadd87b48abbd74b8ba1755dffd",
      "app_name" : "app_13e0",
      "app_remark" : "ds",
      "app_key" : "b11ae87581b04b5284aa92b0d4ae332c",
      "app_secret" : "cb5d1b57368b4f129b635332a03bf0e3",
      "user_id" : "04f258c8fb00d42a1f65c00df88cc4dc",
      "project_id" : "04f258c84780d5a52f3bc00dc15aa5e7",
      "app_type" : "APIG",
      "app_codes" : [ "53a7c6de82be4671b93414adf98c1c507d5cef29fbdd48d88a4dddb668b0f0ad" ],
      "created_at" : 1683173880900,
      "updated_at" : 1700531228874,
      "bounded_api_count" : 28
    },
    "authed" : true
  } ],
  "count" : 1,
  "total_count" : 1
}

Status Codes

Status Code

Description

200

OK

400

Bad Request

Error Codes

See Error Codes.