sailpoint.v2024.PublicIdentitiesConfigApi

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 approvers making approvals, 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/v2024

Method	HTTP request	Description
get-public-identity-config	GET /public-identities-config	Get the Public Identities Configuration
update-public-identity-config	PUT /public-identities-config	Update the Public Identities Configuration

get-public-identity-config

Get the Public Identities Configuration Returns the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

PublicIdentityConfig

Responses

Code	Description	Data Type	Response headers
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.	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

from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # Get the Public Identities Configuration
        
        results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
        # Below is a request that includes all optional parameters
        # results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
        print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e)

[Back to top]

update-public-identity-config

Update the Public Identities Configuration Updates the publicly visible attributes of an identity available to request approvers for Access Requests and Certification Campaigns.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	public_identity_config	PublicIdentityConfig	True

Return type

PublicIdentityConfig

Responses

Code	Description	Data Type	Response headers
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.	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

from sailpoint.v2024.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.public_identity_config import PublicIdentityConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    public_identity_config = '''{
          "modified" : "2018-06-25T20:22:28.104Z",
          "attributes" : [ {
            "name" : "Country",
            "key" : "country"
          }, {
            "name" : "Country",
            "key" : "country"
          } ],
          "modifiedBy" : {
            "name" : "Thomas Edison",
            "id" : "2c9180a46faadee4016fb4e018c20639",
            "type" : "IDENTITY"
          }
        }''' # PublicIdentityConfig | 

    try:
        # Update the Public Identities Configuration
        new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config)
        results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config)
        # Below is a request that includes all optional parameters
        # results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
        print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e)

[Back to top]