Tenant
API for reading tenant details.
All URIs are relative to https://sailpoint.api.identitynow.com/v2024
Method | HTTP request | Description |
---|---|---|
Get-V2024Tenant | GET /tenant | Get Tenant Information. |
get-tenant
This rest endpoint can be used to retrieve tenant details.
Parameters
Param Type | Name | Data Type | Required | Description |
---|
Return type
Responses
Code | Description | Data Type |
---|---|---|
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
# Get Tenant Information.
try {
Get-V2024Tenant
# Below is a request that includes all optional parameters
# Get-V2024Tenant
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-V2024Tenant"
Write-Host $_.ErrorDetails
}