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.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.

If you are using identity policy-based authorization, the following identity policy-based permissions are required.

Action	Access Level	Resource Type (*: required)	Condition Key	Alias	Dependencies
organizations:tags:list	List	account	g:ResourceTag/<tag-key>	-	-
		ou	g:ResourceTag/<tag-key>
		root	g:ResourceTag/<tag-key>
		policy	g:ResourceTag/<tag-key>

URI

GET /v1/organizations/{resource_type}/{resource_id}/tags

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
resource_type	Yes	String	Definition Resource type. It can be organizations:policies, organizations:ous, organizations:accounts, or organizations:roots. Constraints Mandatory Range Enumerated values: organizations:policies, organizations:ous, organizations:accounts, and organizations:roots. Default Value No default value
resource_id	Yes	String	Definition Unique ID of a root, OU, account, or policy. Constraints Mandatory Range The value must comply with the regular expression ^(?:r-[0-9a-z]{4,32}\|[\w-]+\|ou-[0-9a-z]{8,32}\|p-[0-9a-zA-Z_]{8,128})$. The value contains a maximum of 130 characters. Default Value No default value

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Maximum number of results on the page. If the limit is not specified, the default value is 1,000.
marker	No	String	Definition Pagination marker. Constraints N/A Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_.]+$. The value contains 4 to 400 characters. Default Value No default value

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Security-Token	No	String	Definition Security token (session token) of your temporary security credentials. If a temporary security credential is used, this header is required. Constraints N/A Range The value contains 0 to 32,768 characters. Default Value No default value

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
tags	Array of TagDto objects	Definition Tag list. Constraints Mandatory Range N/A Default Value No default value
page_info	PageInfoDto object	Definition Pagination information. Constraints N/A Range N/A Default Value No default value

**Table 5** TagDto
Parameter	Type	Description
key	String	Definition Identifier or name of the tag key. Constraints Mandatory Range The value must comply with the regular expression ^((?!sys\|\s)[\p{L}\p{Z}\p{N}.:=+-@][\p{L}\p{N}.:=+-@])$. The value contains 1 to 128 characters. Default Value* None
value	String	Definition String value associated with the tag key. You can set the tag value to an empty string, but cannot set it to NULL. Constraints Mandatory Range The value must comply with the regular expression ^([\p{L}\p{Z}\p{N}_.:/=+-@])$. The value contains 0 to 255 characters. Default Value* None

**Table 6** PageInfoDto
Parameter	Type	Description
next_marker	String	Definition 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. Constraints Mandatory Range The value must comply with the regular expression ^[A-Za-z0-9+/=-_]+$. Default Value No default value
current_count	Integer	Definition Number of records returned on this page. Constraints N/A Range The value ranges from 1 to 2000. Default Value No default value

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
  }
}