sailpoint.tenant_context.TenantContextApi

The purpose of this API is to manage key-value pairs specific to a tenant's context, enabling dynamic configuration and personalized settings per tenant. Context key-value pairs will consist of common terms and acronyms used within your organization.

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

Method	HTTP request	Description
get-tenant-context-v1	GET /tenant-context/v1	Retrieve tenant context
patch-tenant-context-v1	PATCH /tenant-context/v1	Update tenant context

get-tenant-context-v1

Retrieve tenant context Returns all key-value pairs representing the current state of the tenant's context. Each tenant is limited to a maximum of 100 key-value pairs.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

List[GetTenantContextV1200ResponseInner]

Responses

Code	Description	Data Type	Response headers
200	Successfully retrieved tenant context.	List[GetTenantContextV1200ResponseInner]	-
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.	GetTenantContextV1401Response	-
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.	GetTenantContextV1429Response	-
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.tenant_context.api.tenant_context_api import TenantContextApi
from sailpoint.tenant_context.api_client import ApiClient
from sailpoint.tenant_context.models.get_tenant_context_v1200_response_inner import GetTenantContextV1200ResponseInner
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

    try:
        # Retrieve tenant context
        
        results = TenantContextApi(api_client).get_tenant_context_v1()
        # Below is a request that includes all optional parameters
        # results = TenantContextApi(api_client).get_tenant_context_v1()
        print("The response of TenantContextApi->get_tenant_context_v1:\n")
        for item in results:
            print(item.model_dump_json(by_alias=True, indent=4))
    except Exception as e:
        print("Exception when calling TenantContextApi->get_tenant_context_v1: %s\n" % e)

[Back to top]

patch-tenant-context-v1

Update tenant context Allows the user to make incremental updates to tenant context records using JSON Patch syntax.

This endpoint is specifically designed to modify the /Key/* field, supporting operations such as add, remove, or replace to manage key-value pairs.

Note that each tenant is limited to a maximum of 100 key-value pairs.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Body	json_patch_operation	JsonPatchOperation	True

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
200	Tenant context updated successfully.		-
400	Bad request due to invalid input parameters.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	GetTenantContextV1401Response	-
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	-
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.	GetTenantContextV1429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

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

Example

from sailpoint.tenant_context.api.tenant_context_api import TenantContextApi
from sailpoint.tenant_context.api_client import ApiClient
from sailpoint.tenant_context.models.json_patch_operation import JsonPatchOperation
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
    json_patch_operation = '''{
          "op" : "replace",
          "path" : "/description",
          "value" : "New description"
        }''' # JsonPatchOperation | 

    try:
        # Update tenant context
        new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
        TenantContextApi(api_client).patch_tenant_context_v1(json_patch_operation=new_json_patch_operation)
        # Below is a request that includes all optional parameters
        # TenantContextApi(api_client).patch_tenant_context_v1(new_json_patch_operation)
    except Exception as e:
        print("Exception when calling TenantContextApi->patch_tenant_context_v1: %s\n" % e)

[Back to top]