Skip to main content

Tenant

API for reading tenant details.

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

MethodHTTP requestDescription
Get-BetaTenantGET /tenantGet Tenant Information.

get-tenant

This rest endpoint can be used to retrieve tenant details.

API Spec

Parameters

Param TypeNameData TypeRequiredDescription

Return type

Tenant

Responses

CodeDescriptionData Type
200Tenant InfoTenant
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.ListAccessModelMetadataAttribute401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too 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
500Internal 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]