apis
/
Tenants

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers
Mock server
https://docs.bndry.net/_mock/apis/openapi/

Form Definitions

Operations

Workspaces

Operations

Entities

Operations

Tenants

Operations

CreateTenant

Request

Creates a new tenant.

Returns a google.longrunning.Operation which can be used to track the progress of the tenant creation. The Operation will contain the created Tenant resource upon completion.

Path
tenant.namestring(name)required

The resource name of the tenant.

Format: tenants/{tenant}

Bodyapplication/json

The tenant to create.

namestring(name)

(IDENTIFIER) The resource name of the tenant.

Format: tenants/{tenant}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/api/v1alpha/{tenant.name=tenants/*}' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "displayName": "string",
    "createTime": "2019-08-24T14:15:22Z",
    "updateTime": "2019-08-24T14:15:22Z"
  }'

Responses

Success

Bodyapplication/json
Any of:

This resource represents a long-running operation that is the result of a network API call.

namestring(name)

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

metadataobject(google.protobuf.Any)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

doneboolean(done)

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

errorobject(google.rpc.Status)required

The error result of the operation in case of failure or cancellation.

error.​codeinteger(int32)(code)

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

error.​messagestring(message)

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

error.​detailsArray of objects(details)

A list of messages that carry the error details. There is a common set of message types for APIs to use.

responseobject(google.protobuf.Any)

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Response
application/json
{
  "name": "string",
  "metadata": {
    "type": "string",
    "value": "string",
    "debug": {}
  },
  "done": true,
  "error": {
    "code": 0,
    "message": "string",
    "details": [ … ]
  },
  "response": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

GetTenant

Request

Gets a tenant.

Path
namestring(name)required

The resource name of the tenant to retrieve.

Format: tenants/{tenant}

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

Responses

Success

Bodyapplication/json
namestring(name)

(IDENTIFIER) The resource name of the tenant.

Format: tenants/{tenant}

displayNamestring(display_name)[ 1 .. 63 ] charactersrequired

A human-readable name for display purposes.

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

The timestamp when the tenant was created.

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

The timestamp when the tenant was last updated.

Response
application/json
{
  "name": "string",
  "displayName": "string",
  "createTime": "2019-08-24T14:15:22Z",
  "updateTime": "2019-08-24T14:15:22Z"
}

bndry.workflows.tenantprovisioning.v1alpha.TenantProvisioning

Operations