developer.sailpoint.com/docs/tools/sdk/powershell/Reference/V2024/Methods/V2024TenantApi.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	powershellsdk	powershell PowerShell sdk Tenant V2024Tenant	/tools/sdk/powershell/v2024/methods/tenant	SDK Software Development Kit Tenant V2024Tenant

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

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

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
XSailPointExperimental	String	True (default to "true")	Use this header to enable this experimental API.

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

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")

# Get Tenant Information.

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

[Back to top]