Skip to main content

sailpoint.beta.OrgConfigApi

Use this API to implement organization configuration functionality. Administrators can use this functionality to manage organization settings, such as time zones.

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

MethodHTTP requestDescription
get-org-configGET /org-configGet Org configuration settings
get-valid-time-zonesGET /org-config/valid-time-zonesGet list of time zones
patch-org-configPATCH /org-configPatch an Org configuration property

get-org-config

Get Org configuration settings Get org configuration with only external (org admin) accessible properties for the current org.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

OrgConfig

Responses

CodeDescriptionData TypeResponse headers
200Request succeeded.OrgConfig-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.org_config import OrgConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

try:
# Get Org configuration settings

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

[Back to top]

get-valid-time-zones

Get list of time zones Get a list of valid time zones that can be set in org configurations.

API Spec

Parameters

This endpoint does not need any parameter.

Return type

List[str]

Responses

CodeDescriptionData TypeResponse headers
200Request successfulList[str]-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
429Too 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-
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto-

HTTP request headers

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

Example

from sailpoint.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:

try:
# Get list of time zones

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

[Back to top]

patch-org-config

Patch an Org configuration property Patch configuration of the current org using http://jsonpatch.com/ syntax. Commonly used for changing the time zone of an org.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription
Bodyjson_patch_operation[]JsonPatchOperationTrueA list of schema attribute update operations according to the JSON Patch standard.

Return type

OrgConfig

Responses

CodeDescriptionData TypeResponse headers
200The Org was successfully patched.OrgConfig-
400Client Error - Returned if the request body is invalid.ErrorResponseDto-
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response-
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto-
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto-
429Too 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-
500Internal 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.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
from sailpoint.beta.models.org_config import OrgConfig
from sailpoint.configuration import Configuration
configuration = Configuration()


with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.

try:
# Patch an Org configuration property
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OrgConfigApi(api_client).patch_org_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = OrgConfigApi(api_client).patch_org_config(new_json_patch_operation)
print("The response of OrgConfigApi->patch_org_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling OrgConfigApi->patch_org_config: %s\n" % e)

[Back to top]