developer.sailpoint.com/docs/tools/sdk/powershell/Reference/Beta/Methods/BetaTenantApi.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
beta-tenant	Tenant	Tenant	Tenant	powershellsdk	powershell PowerShell sdk Tenant BetaTenant	/tools/sdk/powershell/beta/methods/tenant	SDK Software Development Kit Tenant BetaTenant

Tenant

API for reading tenant details.

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

Method	HTTP request	Description
Get-BetaTenant	GET /tenant	Get tenant information.

get-tenant

This rest endpoint can be used to retrieve tenant details.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description

Return type

Tenant

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.	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

# Get tenant information.

try {
    Get-BetaTenant 
    
    # Below is a request that includes all optional parameters
    # Get-BetaTenant  
} catch {
    Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Get-BetaTenant"
    Write-Host $_.ErrorDetails
}

[Back to top]