sailpoint.v2024.CustomPasswordInstructionsApi

Use this API to implement custom password instruction functionality. With this functionality in place, administrators can create custom password instructions to help users reset their passwords, change them, unlock their accounts, or recover their usernames. This allows administrators to emphasize password policies or provide organization-specific instructions.

Administrators must first use Update Password Org Config to set `customInstructionsEnabled` to `true`.

Once they have enabled custom instructions, they can use Create Custom Password Instructions to create custom page content for the specific pageId they select.

For example, an administrator can use the pageId forget-username:user-email to set the custom text for the case when users forget their usernames and must enter their emails.

Refer to Creating Custom Instruction Text for more information about creating custom password instructions.

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

Method	HTTP request	Description
create-custom-password-instructions	POST `/custom-password-instructions`	Create Custom Password Instructions
delete-custom-password-instructions	DELETE `/custom-password-instructions/{pageId}`	Delete Custom Password Instructions by page ID
get-custom-password-instructions	GET `/custom-password-instructions/{pageId}`	Get Custom Password Instructions by Page ID

create-custom-password-instructions

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
  configuration.experimental = True

Create Custom Password Instructions This API creates the custom password instructions for the specified page ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	custom_password_instruction	CustomPasswordInstruction	True

Return type

CustomPasswordInstruction

Responses

Code	Description	Data Type	Response headers
200	Reference to the custom password instructions.	CustomPasswordInstruction	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
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.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = true

with ApiClient(configuration) as api_client:
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    custom_password_instruction = '''{
          "pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.",
          "pageId" : "change-password:enter-password",
          "locale" : "en"
        }''' # CustomPasswordInstruction | 

    try:
        # Create Custom Password Instructions
        new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction)
        results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental=x_sail_point_experimental, custom_password_instruction=new_custom_password_instruction)
        # Below is a request that includes all optional parameters
        # results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(x_sail_point_experimental, new_custom_password_instruction)
        print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomPasswordInstructionsApi->create_custom_password_instructions: %s\n" % e)

[Back to top]

delete-custom-password-instructions

experimental

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
  configuration.experimental = True

Delete Custom Password Instructions by page ID This API delete the custom password instructions for the specified page ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	page_id	str	True	The page ID of custom password instructions to delete.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Query	locale	str	(optional)	The locale for the custom instructions, a BCP47 language tag. The default value is \"default\".

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
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	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
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.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = true

with ApiClient(configuration) as api_client:
    page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)

    try:
        # Delete Custom Password Instructions by page ID
        
        CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, x_sail_point_experimental, locale)
    except Exception as e:
        print("Exception when calling CustomPasswordInstructionsApi->delete_custom_password_instructions: %s\n" % e)

[Back to top]

get-custom-password-instructions

experimental

setting x-sailpoint-experimental header

on the configuration object you can set the x-sailpoint-experimental header to `true' to enable all experimantl endpoints within the SDK. Example:

  configuration = Configuration()
  configuration.experimental = True

Get Custom Password Instructions by Page ID This API returns the custom password instructions for the specified page ID.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	page_id	str	True	The page ID of custom password instructions to query.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Query	locale	str	(optional)	The locale for the custom instructions, a BCP47 language tag. The default value is \"default\".

Return type

CustomPasswordInstruction

Responses

Code	Description	Data Type	Response headers
200	Reference to the custom password instructions.	CustomPasswordInstruction	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
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.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.custom_password_instruction import CustomPasswordInstruction
from sailpoint.configuration import Configuration
configuration = Configuration()

configuration.experimental = true

with ApiClient(configuration) as api_client:
    page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)

    try:
        # Get Custom Password Instructions by Page ID
        
        results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id, x_sail_point_experimental=x_sail_point_experimental)
        # Below is a request that includes all optional parameters
        # results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, x_sail_point_experimental, locale)
        print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n")
        print(results.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling CustomPasswordInstructionsApi->get_custom_password_instructions: %s\n" % e)

[Back to top]

create-custom-password-instructions​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

delete-custom-password-instructions​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

get-custom-password-instructions​

Parameters​

Return type​

Responses​

HTTP request headers​

Example​

create-custom-password-instructions

Parameters

Return type

Responses

HTTP request headers

Example

delete-custom-password-instructions

Parameters

Return type

Responses

HTTP request headers

Example

get-custom-password-instructions

Parameters

Return type

Responses

HTTP request headers

Example