mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
starting point for adding python sdk docs
This commit is contained in:
75
docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md
Normal file
75
docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md
Normal file
@@ -0,0 +1,75 @@
|
||||
---
|
||||
id: beta-tenant
|
||||
title: Tenant
|
||||
pagination_label: Tenant
|
||||
sidebar_label: Tenant
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Tenant', 'BetaTenant']
|
||||
slug: /tools/sdk/python/beta/methods/tenant
|
||||
tags: ['SDK', 'Software Development Kit', 'Tenant', 'BetaTenant']
|
||||
---
|
||||
|
||||
# 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**](TenantApi#get-tenant) | **GET** `/tenant` | Get Tenant Information.
|
||||
|
||||
|
||||
## get-tenant
|
||||
Get Tenant Information.
|
||||
This rest endpoint can be used to retrieve tenant details.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-tenant)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**Tenant**](../models/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. | 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
|
||||
|
||||
```python
|
||||
import sailpoint.beta
|
||||
from sailpoint.beta.models.tenant import Tenant
|
||||
from sailpoint.beta.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
|
||||
try:
|
||||
# Get Tenant Information.
|
||||
|
||||
api_response = api_instance.get_tenant()
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_tenant()
|
||||
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]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user