Files
developer.sailpoint.com/docs/extensibility/transforms/operations/get-reference-identity-attribute.md
2024-02-28 12:14:29 -05:00

88 lines
3.1 KiB
Markdown

---
id: get-reference-identity-attribute
title: Get Reference Identity Attribute
pagination_label: Get Reference Identity Attribute
sidebar_label: Get Reference Identity Attribute
sidebar_class_name: getReferenceIdentityAttribute
keywords:
['transforms', 'operations', 'get', 'reference', 'identity', 'attribute']
description: Get another user's identity attribute.
slug: /extensibility/transforms/operations/get-reference-identity-attribute
tags: ['Transforms', 'Transform Operations']
---
## Overview
Use the get reference identity attribute transform as an out-of-the-box rule provided through SailPoint's Cloud Services Deployment Utility rule. The transform allows you to get the identity attribute of another user from within a given identity's calculation. For your convenience, the transform allows you to use "manager" as a referential lookup to the target identity.
## Transform Structure
The structure of a get reference identity transform requires the `name` of the referenced rule to be the `Cloud Services Deployment Utility` rule built by SailPoint. Additionally, you must set the `operation` to `getReferenceIdentityAttribute` and specify a `uid` attribute that correlates to the identity whose attribute is desired. Last, you must include the `type` and `name` attributes required for all transforms:
```json
{
"attributes": {
"name": "Cloud Services Deployment Utility",
"operation": "getReferenceIdentityAttribute",
"uid": "manager",
"attributeName": "email"
},
"type": "rule",
"name": "Get Reference Identity Attribute Transform"
}
```
## Attributes
- **Required Attributes**
- **type** - This must always be set to `rule`.
- **name** - This is a required attribute for all transforms. It represents the name of the transform as it will appear in the UI's dropdown menus.
- **attributes.name** - This must always be set to `Cloud Services Deployment Utility`.
- **operation** - This must always be set to `getReferenceIdentityAttribute`.
- **uid** - This is the SailPoint User Name (uid) value of the identity whose attribute is desired.
- For your convenience, you can use the "manager" keyword to look up the user's manager and then get that manager's identity attribute.
- **Optional Attributes**
- **requiresPeriodicRefresh** - This `true` or `false` value indicates whether the transform logic should be reevaluated every evening as part of the identity refresh process.
## Examples
This transform gets the user's manager's email address.
**Transform Request Body**:
```json
{
"attributes": {
"name": "Cloud Services Deployment Utility",
"operation": "getReferenceIdentityAttribute",
"uid": "manager",
"attributeName": "email"
},
"type": "rule",
"name": "Get Reference Identity Attribute Transform"
}
```
---
<p>&nbsp;</p>
This transform gets the alternate phone number for the user identified as "corporate.admin".
**Transform Request Body**:
```json
{
"attributes": {
"name": "Cloud Services Deployment Utility",
"operation": "getReferenceIdentityAttribute",
"uid": "corporate.admin",
"attributeName": "phone"
},
"type": "rule",
"name": "Get Reference Identity Attribute Transform"
}
```