TaggedObjects

Use this API to implement object tagging functionality. With object tagging functionality in place, any user in an organization can use tags as a way to group objects together and find them more quickly when the user searches Identity Security Cloud.

In Identity Security Cloud, users can search their tenants for information and add tags objects they find. Tagging an object provides users with a way of grouping objects together and makes it easier to find these objects in the future.

For example, if a user is searching for an entitlement that grants a risky level of access to Active Directory, it's possible that the user may have to search through hundreds of entitlements to find the correct one. Once the user finds that entitlement, the user can add a tag to the entitlement, "AD_RISKY" to make it easier to find the entitlement again. The user can add the same tag to multiple objects the user wants to group together for an easy future search, and the user can also do so in bulk. When the user wants to find that tagged entitlement again, the user can search for "tags:AD_RISKY" to find all objects with that tag.

With the API, you can tag even more different object types than you can in Identity Security Cloud (access profiles, entitlements, identities, and roles). You can use the API to tag all these objects:

Access profiles
Applications
Certification campaigns
Entitlements
Identities
Roles
SOD (separation of duties) policies
Sources

You can also use the API to directly find, create, and manage tagged objects without using search queries.

There are limits to tags:

You can have up to 500 different tags in your tenant.
You can apply up to 30 tags to one object.
You can have up to 10,000 tag associations, pairings of 1 tag to 1 object, in your tenant.

Because of these limits, it is recommended that you work with your governance experts and security teams to establish a list of tags that are most expressive of governance objects and access managed by Identity Security Cloud.

These are the types of information often expressed in tags:

Affected departments
Compliance and regulatory categories
Remediation urgency levels
Risk levels

Refer to Tagging Items in Search for more information about tagging objects in Identity Security Cloud.

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
Remove-V2024TaggedObject	DELETE `/tagged-objects/{type}/{id}`	Delete Object Tags
Remove-V2024TagsToManyObject	POST `/tagged-objects/bulk-remove`	Remove Tags from Multiple Objects
Get-V2024TaggedObject	GET `/tagged-objects/{type}/{id}`	Get Tagged Object
Get-V2024TaggedObjects	GET `/tagged-objects`	List Tagged Objects
Get-V2024TaggedObjectsByType	GET `/tagged-objects/{type}`	List Tagged Objects by Type
Send-V2024TaggedObject	PUT `/tagged-objects/{type}/{id}`	Update Tagged Object
Set-V2024TagToObject	POST `/tagged-objects`	Add Tag to Object
Set-V2024TagsToManyObjects	POST `/tagged-objects/bulk-add`	Tag Multiple Objects

delete-tagged-object

Delete all tags from a tagged object.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Type	String	True	The type of object to delete tags from.
Path	Id	String	True	The ID of the object to delete tags from.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Type = "ACCESS_PROFILE" # String | The type of object to delete tags from.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object to delete tags from.

# Delete Object Tags

try {
    Remove-V2024TaggedObject -Type $Type -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024TaggedObject -Type $Type -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TaggedObject"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-tags-to-many-object

This API removes tags from multiple objects.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	BulkRemoveTaggedObject	BulkRemoveTaggedObject	True	Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.

Return type

(empty response body)

Responses

Code	Description	Data Type
204	No content - indicates the request was successful but there is no content to be returned in the response.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$BulkRemoveTaggedObject = @"{
  "objectRefs" : [ {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  }, {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  } ],
  "tags" : [ "BU_FINANCE", "PCI" ]
}"@

# Remove Tags from Multiple Objects

try {
    $Result = ConvertFrom-JsonToBulkRemoveTaggedObject -Json $BulkRemoveTaggedObject
    Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result 
    
    # Below is a request that includes all optional parameters
    # Remove-V2024TagsToManyObject -V2024BulkRemoveTaggedObject $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Remove-V2024TagsToManyObject"
    Write-Host $_.ErrorDetails
}

[Back to top]

get-tagged-object

This gets a tagged object for the specified type.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Type	String	True	The type of tagged object to retrieve.
Path	Id	String	True	The ID of the object reference to retrieve.

Return type

TaggedObject

Responses

Code	Description	Data Type
200	Tagged object by type and ID.	TaggedObject
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to retrieve.

# Get Tagged Object

try {
    Get-V2024TaggedObject -Type $Type -Id $Id 
    
    # Below is a request that includes all optional parameters
    # Get-V2024TaggedObject -Type $Type -Id $Id  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObject"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-tagged-objects

This API returns a list of all tagged objects.

Any authenticated token may be used to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: objectRef.id: eq, in objectRef.type: eq, in tagName: eq, in

Return type

TaggedObject[]

Responses

Code	Description	Data Type
200	List of all tagged objects.	TaggedObject[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'tagName eq "BU_FINANCE"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **objectRef.id**: *eq, in*  **objectRef.type**: *eq, in*  **tagName**: *eq, in* (optional)

# List Tagged Objects

try {
    Get-V2024TaggedObjects 
    
    # Below is a request that includes all optional parameters
    # Get-V2024TaggedObjects -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjects"
    Write-Host $_.ErrorDetails
}

[Back to top]

list-tagged-objects-by-type

This API returns a list of all tagged objects by type.

Any authenticated token may be used to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Type	String	True	The type of tagged object to retrieve.
Query	Limit	Int32	(optional) (default to 250)	Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query	Offset	Int32	(optional) (default to 0)	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.
Query	Count	Boolean	(optional) (default to $false)	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.
Query	Filters	String	(optional)	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: objectRef.id: eq objectRef.type: eq

Return type

TaggedObject[]

Responses

Code	Description	Data Type
200	List of all tagged objects for specified type.	TaggedObject[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

$Type = "ACCESS_PROFILE" # String | The type of tagged object to retrieve.
$Limit = 250 # Int32 | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
$Offset = 0 # Int32 | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
$Count = $true # Boolean | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to $false)
$Filters = 'objectRef.id eq "2c91808568c529c60168cca6f90c1313"' # String | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **objectRef.id**: *eq*  **objectRef.type**: *eq* (optional)

# List Tagged Objects by Type

try {
    Get-V2024TaggedObjectsByType -Type $Type 
    
    # Below is a request that includes all optional parameters
    # Get-V2024TaggedObjectsByType -Type $Type -Limit $Limit -Offset $Offset -Count $Count -Filters $Filters  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024TaggedObjectsByType"
    Write-Host $_.ErrorDetails
}

[Back to top]

put-tagged-object

This updates a tagged object for the specified type.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	Type	String	True	The type of tagged object to update.
Path	Id	String	True	The ID of the object reference to update.
Body	TaggedObject	TaggedObject	True

Return type

TaggedObject

Responses

Code	Description	Data Type
200	Tagged object by type and ID.	TaggedObject
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$Type = "ACCESS_PROFILE" # String | The type of tagged object to update.
$Id = "ef38f94347e94562b5bb8424a56397d8" # String | The ID of the object reference to update.
$TaggedObject = @"{
  "objectRef" : {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  },
  "tags" : [ "BU_FINANCE", "PCI" ]
}"@

# Update Tagged Object

try {
    $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
    Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result 
    
    # Below is a request that includes all optional parameters
    # Send-V2024TaggedObject -Type $Type -Id $Id -V2024TaggedObject $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Send-V2024TaggedObject"
    Write-Host $_.ErrorDetails
}

[Back to top]

set-tag-to-object

This adds a tag to an object.

Any authenticated token may be used to call this API.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	TaggedObject	TaggedObject	True

Return type

(empty response body)

Responses

Code	Description	Data Type
201	Created.
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$TaggedObject = @"{
  "objectRef" : {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  },
  "tags" : [ "BU_FINANCE", "PCI" ]
}"@

# Add Tag to Object

try {
    $Result = ConvertFrom-JsonToTaggedObject -Json $TaggedObject
    Set-V2024TagToObject -V2024TaggedObject $Result 
    
    # Below is a request that includes all optional parameters
    # Set-V2024TagToObject -V2024TaggedObject $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagToObject"
    Write-Host $_.ErrorDetails
}

[Back to top]

set-tags-to-many-objects

This API adds tags to multiple objects.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	BulkAddTaggedObject	BulkAddTaggedObject	True	Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.

Return type

BulkTaggedObjectResponse[]

Responses

Code	Description	Data Type
200	Request succeeded.	BulkTaggedObjectResponse[]
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

$BulkAddTaggedObject = @"{
  "objectRefs" : [ {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  }, {
    "name" : "William Wilson",
    "id" : "2c91808568c529c60168cca6f90c1313",
    "type" : "IDENTITY"
  } ],
  "operation" : "MERGE",
  "tags" : [ "BU_FINANCE", "PCI" ]
}"@

# Tag Multiple Objects

try {
    $Result = ConvertFrom-JsonToBulkAddTaggedObject -Json $BulkAddTaggedObject
    Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result 
    
    # Below is a request that includes all optional parameters
    # Set-V2024TagsToManyObjects -V2024BulkAddTaggedObject $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Set-V2024TagsToManyObjects"
    Write-Host $_.ErrorDetails
}

[Back to top]

delete-tagged-object​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-tags-to-many-object​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-tagged-object​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

list-tagged-objects​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

list-tagged-objects-by-type​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

put-tagged-object​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

set-tag-to-object​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

set-tags-to-many-objects​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-tagged-object

Parameters

Return type

Responses

HTTP request headers

Example

delete-tags-to-many-object

Parameters

Return type

Responses

HTTP request headers

Example

get-tagged-object

Parameters

Return type

Responses

HTTP request headers

Example

list-tagged-objects

Parameters

Return type

Responses

HTTP request headers

Example

list-tagged-objects-by-type

Parameters

Return type

Responses

HTTP request headers

Example

put-tagged-object

Parameters

Return type

Responses

HTTP request headers

Example

set-tag-to-object

Parameters

Return type

Responses

HTTP request headers

Example

set-tags-to-many-objects

Parameters

Return type

Responses

HTTP request headers

Example