PublicIdentitiesConfig

Use this API to implement public identity configuration functionality. With this functionality in place, administrators can make up to 5 identity attributes publicly visible so other non-administrator users can see the relevant information they need to make decisions. This can be helpful for access approvers, certification reviewers, managers viewing their direct reports' access, and source owners viewing their tasks.

By default, non-administrators can select an identity and view the following attributes: email, lifecycle state, and manager. However, it may be helpful for a non-administrator reviewer to see other identity attributes like department, region, title, etc. Administrators can use this API to make those necessary identity attributes public to non-administrators.

For example, a non-administrator deciding whether to approve another identity's request for access to the Workday application, whose access may be restricted to members of the HR department, would want to know whether the identity is a member of the HR department. If an administrator has used Update Public Identity Config to make the "department" attribute public, the approver can see the department and make a decision without requesting any more information.

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

Method	HTTP request	Description
Get-BetaPublicIdentityConfig	GET /public-identities-config	Get Public Identity Config
Update-BetaPublicIdentityConfig	PUT /public-identities-config	Update Public Identity Config

get-public-identity-config

This gets details of public identity config.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description

Return type

PublicIdentityConfig

Responses

Code	Description	Data Type
200	Request succeeded.	PublicIdentityConfig
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

# Get Public Identity Config

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

[Back to top]

update-public-identity-config

This updates the details of public identity config.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	PublicIdentityConfig	PublicIdentityConfig	True

Return type

PublicIdentityConfig

Responses

Code	Description	Data Type
200	Request succeeded.	PublicIdentityConfig
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.	ListAccessModelMetadataAttribute401Response
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.	ListAccessModelMetadataAttribute429Response
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto

HTTP request headers

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

Example

$PublicIdentityConfig = @"{
  "modified" : "2018-06-25T20:22:28.104Z",
  "attributes" : [ {
    "name" : "Country",
    "key" : "country"
  }, {
    "name" : "Country",
    "key" : "country"
  } ],
  "modifiedBy" : {
    "name" : "Thomas Edison",
    "id" : "2c9180a46faadee4016fb4e018c20639",
    "type" : "IDENTITY"
  }
}"@

# Update Public Identity Config

try {
    $Result = ConvertFrom-JsonToPublicIdentityConfig -Json $PublicIdentityConfig
    Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result 
    
    # Below is a request that includes all optional parameters
    # Update-BetaPublicIdentityConfig -BetaPublicIdentityConfig $Result  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Update-BetaPublicIdentityConfig"
    Write-Host $_.ErrorDetails
}

[Back to top]