Lists a page of tenants

POST 
/api/web/v4/tenantspaged

Returns tenants for the provided search parameters. Caller requires the TENANTS:VIEW permission. The following searchByAttributes are supported:

• hostname: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
• companyName: a String up to 100 characters. Allowed operators are: EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH.
• contractMode: PRODUCTION, TRIAL, UNKNOWN. Allowed operator: EQUALS.
• locked: true or false. Allowed operator: EQUALS.
• serviceProvider: true or false. Allowed operator: EQUALS.
• authenticationAccount: true or false. Allowed operator: EQUALS.
• issuanceAccount: true or false. Allowed operator: EQUALS.
• spIdp: true or false. Allowed operator: EQUALS.

The orderByAttribute supports these attribute names: hostname, companyName, contractMode, locked, serviceProvider, authenticationAccount, issuanceAccount, spIdp.

Request

application/json

Body

required

attributes string[]

Users search only: additional, non-core attributes to include in the returned object. Attribute names are specific to the returned object.

cursor string

Identifies the page to return when paging over a result set--if present, search by / order by attributes are ignored.

limit int32

Possible values: >= 1 and <= 100

Identifies the maximum number of items to include in a page (1-100).

orderByAttribute

object

An attribute used to sort the result from a search.

ascending booleanrequired

Identifies whether to order results in ascending order.

name stringrequired

Identifies the attribute.

searchByAttributes

object[]

Identifies attributes for searching purposes. Some end-points have pre-defined values and ignore this attribute.

Array [

name stringrequired

Identifies the attribute we are searching for.

operator stringrequired

Possible values: [EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, STARTS_WITH, ENDS_WITH, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL, IN, EXISTS, NOT_EXISTS]

Identifies the operator.

value string

Identifies the value of the attribute we are searching for.

]

Responses

200

Successful

application/json

Schema

Schema

paging

object

Contains navigation information.

limit int32required

Possible values: >= 1 and <= 100

The page limit used (1-100)

nextCursor string

The cursor pointing to the next page.

prevCursor string

The cursor pointing to the previous page.

results

object[]

required

A single page with the list of tenants found.

Array [

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)

{
  "paging": {
    "limit": 0,
    "nextCursor": "string",
    "prevCursor": "string"
  },
  "results": [
    {
      "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...