API Reference
/
Tenants
/
Retrieve a tenant

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server

https://docs.bndry.net/_mock/apis/openapi/

Documents

Service for managing documents.

Operations

Form Definitions

Service for managing form definitions.

Operations

FormService

Operations

Workspaces

Service for managing workspaces and their associated forms and documents.

Operations

Automations

Service for managing and executing automations.

Operations

NotesService

Operations

Tenants

Service for managing tenants.

Operations

Retrieve a tenant

Request

Retrieves a tenant.

Path
tenantstringrequired

The tenant id.

Query
namestring(name)required

Required. The resource name of the tenant to retrieve. Format: tenants/{tenant}

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/v1alpha/tenants/{tenant}?name=string'

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the tenant. Format: tenants/{tenant}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

Optional. A mutable, user-settable field for providing a human-readable name for the tenant, to be used in user interfaces. Must be <= 63 characters.

createTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the tenant was created.

updateTimestring(date-time)(google.protobuf.Timestamp)read-only

Output only. The timestamp when the tenant was most recently updated.

Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "1s",
  "updateTime": "1s"
}

Entities

Operations

TruuthService

TruuthService provides an API for the BNDRY SPA to initiate a new verification session with Truuth

Operations