Skip to main content

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​

Responses​

Successful