DocsICP FilingConsole
Documentation

ListAuthConfigByResource

Updated at:
Copy as MD
Product
My Favorites

Queries the list of collaborative authorization records for a resource.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example
ResourceId

string

Yes

The ID of the resource to authorize.

al*************7ufv
WorksType

string

Yes

The type of the authorization resource. Valid values:

  • dashboard: dashboard.

  • screen: data visualization.

  • report: electron.

  • ANALYSIS: ad hoc analysis.

  • dashboardOfflineQuery: self-service data retrieval.

  • dataForm: data entry form.

  • cube: dataset.

  • datasource: data source.

REPORT
ShareToType

integer

Yes

The query granularity. Valid values:

  • 0: user.

  • 1: user group.

Important Authorization records for organizations and workspaces are returned at the user granularity. Datasets and data sources can only be authorized to users.

0
HasAuth

boolean

Yes

Specifies whether to query only records with permissions.

true
Keyword

string

No

The search keyword for the authorized object.

test

Response elements

Element

Type

Description

Example

object

RequestId

string

The request ID.

019FA14C-ED6B-5F39-8563-855676470C47
Result

array<object>

The collection of authorization details.

object

The authorization details.

Authorities

array

The array of permissions granted.

string

The permission granted. Valid values:

  • READ: read.

  • EXPORT: export.

  • EDITE: edit.

READ
AuthorizedId

string

The ID of the authorized user.

123123**dfsd
AuthorizedName

string

The name of the authorized user.

sss
ExpireDate

string

The expiration time.

1788969600000
GmtCreate

string

The creation time of the authorization record, in the yyyy-MM-dd mm:hh:ss format.

2024-04-16 13:17:39
ResourceId

string

The resource ID.

123123**dfsd
ResourceType

string

The resource type. Valid values:

  • dashboard: dashboard.

  • screen: data visualization.

  • report: electron.

  • ANALYSIS: ad hoc analysis.

  • dashboardOfflineQuery: self-service data retrieval.

  • dataForm: data entry form.

  • cube: dataset.

  • datasource: data source.

cube
Scope

integer

The authorization scope. Valid values:

  • 0: user.

  • 1: user group.

  • 2: organization.

  • 3: workspace.

0
Success

boolean

Indicates whether the request was successful.

true

Examples

Success response

JSON format

{
  "RequestId": "019FA14C-ED6B-5F39-8563-855676470C47",
  "Result": [
    {
      "Authorities": [
        "READ"
      ],
      "AuthorizedId": "123123**dfsd",
      "AuthorizedName": "sss",
      "ExpireDate": "1788969600000",
      "GmtCreate": "2024-04-16 13:17:39",
      "ResourceId": "123123**dfsd",
      "ResourceType": "cube",
      "Scope": 0
    }
  ],
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description
400 Internal.System.Error An internal system error occurred. An internal system error occurred.
400 Invalid.Parameter.Error The parameter is invalid:%s. invalid parameter: ${0}.
400 Cube.Not.Exist The Cube does not exist. The Cube does not exist.
400 Datasource.NotFound.Error The specified data source does not exist: %s. The specified data source does not exist: %s.
400 Work.Not.Exist The work does not exist. The work does not exist.
500 Authorize3Rd.Page.Org.Illegal The report does not match the organization. The report does not match the organization.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.