Get Resource¶

Get the information of all the resources under a resource type.

Operation Permissions¶

Applications assigned with the administrator policy in the OU.

Request Format¶

POST https://{apigw-address}/enos-iam-service/v2.3/iam/ctrl/api/open/v3/get/resource

Request Parameters (URI)¶

Name	Location (Path/Query)	Required/Optional	Data Type	Description
orgId	Query	Required	String	The ID of the OU to which the resource belongs. How to get orgId>>

Request Parameters (Body)¶

Name	Required/Optional	Data Type	Description
resourceType	Required	String	The unique resource type identifier.

Response Parameters¶

Name	Data Type	Description
data	Resource Struct	The resource information, see Resource Struct.

Resource Struct ¶

Name	Data Type	Description
id	String	The resource ID.
name	String	The resource name.
children	Array	Returns the child nodes if the resource has a tree structure.
virtualAll	Boolean	`true`: Identifies this resource as a virtual resource for all resources. `null`: This resource is not identified as a virtual resource.

Samples¶

Request Sample¶

url: https://{apigw-address}/enos-iam-service/v2.3/iam/ctrl/api/open/v3/get/resource?orgId=yourOrgId
method: POST
request Body:
{
  "resourceType": "asset_node"
}

Return Sample¶

{
  "data": [
    {
      "id": "resource1id",
      "name": "resource1",
      "children": [],
      "virtualAll": true
    },
    {
      "id": "resource2id",
      "name": "resource2",
      "children": []
    }
  ],
  "requestId": null,
  "status": 0,
  "message": "",
  "success": true,
  "failed": false,
  "successful": true,
  "fail": false
}