Help Center/ Organizations/ API Reference/ APIs/ Managing Tags/ Listing Tags for the Specified Resource Type

Updated on 2024-10-21 GMT+08:00

View PDF

Listing Tags for the Specified Resource Type

Function

This API is used to list the tags that are attached to the specified resource type. You can attach tags to accounts, OUs, roots, and policies of an organization. This API can be called only from the organization's management account or a delegated administrator account.

Debugging

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

URI

GET https://{endpoint}/v1/organizations/{resource_type}/{resource_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Resource type. It can be organizations:policies, organizations:ous, organizations:accounts, or organizations:roots.
resource_id	Yes	String	Unique ID of the root, OU, account, or policy.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on a page.
marker	No	String	Pagination marker.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tags	Array of TagDto objects	List of tags.
page_info	PageInfoDto object	Pagination information.

**Table 5** TagDto
Parameter	Type	Description
key	String	Identifier or name of the tag key.
value	String	String value associated with the tag key. You can set the tag value to an empty string, but cannot set it to NULL.

**Table 6** PageInfoDto
Parameter	Type	Description
next_marker	String	Marker for the next set of results. If present, more output is available than is included in the current response. Use this value in the marker request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the next_marker response element comes back as null.
current_count	Integer	Number of items returned on the current page.

Example Requests

Listing tags for the specified resource type

GET https://{endpoint}/v1/organizations/{resource_type}/{resource_id}/tags

Example Responses

Status code: 200

Successful.

{
  "tags" : [ {
    "key" : "auto09230Uv5key",
    "value" : "auto0923XXFmvalue"
  } ],
  "page_info" : {
    "next_marker" : "ou-taowxgy4xbme6m4x3c2iijbxw7yj8fcw",
    "current_count" : 100
  }
}