Get a tenant

GET 
/api/web/v4/tenants/:id

Get the specified tenant for a service provider. Caller requires the TENANTS:VIEW permission from a service provider role.

Request

Path Parameters

id stringrequired

The UUID of the tenant to be fetched.

Responses

200

Successful

application/json

Schema

Schema

authenticationAccount booleanrequired

A flag indicating if this tenant is an authentication account.

companyName stringrequired

The name of the company that owns this tenant.

contractMode string

Possible values: [PRODUCTION, TRIAL, UNKNOWN]

The contract mode of a tenant, allowable values = 'PRODUCTION', 'TRIAL', example='TRIAL'.

hostname stringrequired

The hostname of the tenant.

id stringrequired

The UUID of this tenant within the service provider.

issuanceAccount booleanrequired

A flag indicating if this tenant is an issuance account.

locked booleanrequired

A flag indicating if this tenant has been locked.

previousHostname string

The previous hostname of the tenant.

serviceProvider booleanrequired

A flag indicating if this child tenant is a service provider.

spIdp booleanrequired

A flag indicating if this tenant is enabled for tenant management authentication.

Example (from schema)

{
  "authenticationAccount": true,
  "companyName": "MyCompany Corp.",
  "contractMode": "PRODUCTION",
  "hostname": "mycompany.us.trustedauth.com",
  "id": "string",
  "issuanceAccount": true,
  "locked": true,
  "previousHostname": "mycompany.us.trustedauth.com",
  "serviceProvider": true,
  "spIdp": true
}

400

Bad Request

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

401

Access denied

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

403

Forbidden

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

404

Not Found

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

409

Conflict

application/json

Schema

Schema

errorCode string

Error Codes specific to cause of failure.

errorMessage string

Additional Error Message describing the error.

parameters object[]

Optional additional error information.

Example (from schema)

{
  "errorCode": "invalid_user_response",
  "errorMessage": "Application id cannot be null",
  "parameters": [
    {}
  ]
}

Loading...