sailpoint.beta.TenantApi
API for reading tenant details. All URIs are relative to https://sailpoint.api.identitynow.com/beta
| Method | HTTP request | Description |
|---|---|---|
| get-tenant | GET /tenant | Get Tenant Information. |
get-tenant
Get Tenant Information. This rest endpoint can be used to retrieve tenant details.
Parameters
This endpoint does not need any parameter.
Return type
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. | ListAccessModelMetadataAttribute401Response | - |
| 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. | ListAccessModelMetadataAttribute429Response | - |
| 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.beta.api.tenant_api import TenantApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant import Tenant
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Tenant Information.
results = TenantApi(api_client).get_tenant()
# Below is a request that includes all optional parameters
# results = TenantApi(api_client).get_tenant()
print("The response of TenantApi->get_tenant:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling TenantApi->get_tenant: %s\n" % e)