developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Methods/TenantApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-tenant	Tenant	Tenant	Tenant	pythonsdk	python Python sdk Tenant V2024Tenant	/tools/sdk/python/v2024/methods/tenant	SDK Software Development Kit Tenant V2024Tenant

sailpoint.v2024.TenantApi

API for reading tenant details. All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
get-tenant	GET /tenant	Get Tenant Information.

get-tenant

:::warning 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. ::: Get Tenant Information. This rest endpoint can be used to retrieve tenant details.

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.

Return type

Tenant

Responses

Code	Description	Data Type	Response headers
200	Tenant Info	Tenant	-
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	-
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.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.tenant import Tenant
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    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')

    try:
        # Get Tenant Information.
        
        api_response = api_instance.get_tenant(x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_tenant(x_sail_point_experimental)
        print("The response of TenantApi->get_tenant:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling TenantApi->get_tenant: %s\n" % e)

[Back to top]