Tenants Trait
API Service: TenantApi
| Method | Request Type | Response Type | Description |
|---|---|---|---|
| ListTenants | ListTenantsRequest | ListTenantsResponse | |
| PullTenants | PullTenantsRequest | PullTenantsResponse stream | |
| CreateTenant | CreateTenantRequest | Tenant | |
| GetTenant | GetTenantRequest | Tenant | |
| UpdateTenant | UpdateTenantRequest | Tenant | |
| DeleteTenant | DeleteTenantRequest | DeleteTenantResponse | |
| PullTenant | PullTenantRequest | PullTenantResponse stream | |
| AddTenantZones | AddTenantZonesRequest | Tenant | |
| RemoveTenantZones | RemoveTenantZonesRequest | Tenant | |
| ListSecrets | ListSecretsRequest | ListSecretsResponse | |
| PullSecrets | PullSecretsRequest | PullSecretsResponse stream | |
| CreateSecret | CreateSecretRequest | Secret | |
| VerifySecret | VerifySecretRequest | Secret | VerifySecret validates that the given tenant_id has a secret that matches the given secret, returning that secret. An Unauthenticated error will be returned if the tenant+secret do not match or are not known. |
| GetSecret | GetSecretRequest | Secret | |
| UpdateSecret | UpdateSecretRequest | Secret | |
| DeleteSecret | DeleteSecretRequest | DeleteSecretResponse | |
| PullSecret | PullSecretRequest | PullSecretResponse stream | |
| RegenerateSecret | RegenerateSecretRequest | Secret | Creates a new hash for the secret, returns that hash. Just like CreateSecret but using an existing secret |
Tenant
| Field Name | Type | Description |
|---|---|---|
| id | string | |
| title | string | |
| create_time | google.protobuf.Timestamp | |
| zone_names | repeated string | |
| etag | string | Used to avoid read-modify-write conflicts |
Secret
| Field Name | Type | Description |
|---|---|---|
| id | string | |
| tenant | Tenant | The tenant the secret is associated with. On output, by default only id and title will be populated. On input, only populate id, which must correspond to an existing tenant. |
| secret_hash | bytes | A hash of the secret string. Output only. |
| secret | string | The secret string that the tenant can use to authenticate themself. Output only. Only present once, returned from CreateSecret or RegenerateSecret. |
| note | string | |
| create_time | google.protobuf.Timestamp | |
| expire_time | google.protobuf.Timestamp | |
| first_use_time | google.protobuf.Timestamp | |
| last_use_time | google.protobuf.Timestamp | |
| etag | string | Used to avoid read-modify-write conflicts |
ListTenantsRequest
TODO: paging
No fields defined.
ListTenantsResponse
| Field Name | Type | Description |
|---|---|---|
| tenants | repeated Tenant |
PullTenantsRequest
| Field Name | Type | Description |
|---|---|---|
| updates_only | bool |
PullTenantsResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated PullTenantsResponse.Change |
PullTenantsResponse.Change
| Field Name | Type | Description |
|---|---|---|
| change_time | google.protobuf.Timestamp | |
| tenant | Tenant |
CreateTenantRequest
| Field Name | Type | Description |
|---|---|---|
| tenant | Tenant |
GetTenantRequest
| Field Name | Type | Description |
|---|---|---|
| id | string |
UpdateTenantRequest
| Field Name | Type | Description |
|---|---|---|
| tenant | Tenant | |
| update_mask | google.protobuf.FieldMask |
DeleteTenantRequest
| Field Name | Type | Description |
|---|---|---|
| id | string |
DeleteTenantResponse
No fields defined.
PullTenantRequest
| Field Name | Type | Description |
|---|---|---|
| id | string | |
| updates_only | bool |
PullTenantResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated PullTenantResponse.Change |
PullTenantResponse.Change
| Field Name | Type | Description |
|---|---|---|
| change_time | google.protobuf.Timestamp | |
| tenant | Tenant |
AddTenantZonesRequest
| Field Name | Type | Description |
|---|---|---|
| tenant_id | string | |
| add_zone_names | repeated string |
RemoveTenantZonesRequest
| Field Name | Type | Description |
|---|---|---|
| tenant_id | string | |
| remove_zone_names | repeated string |
ListSecretsRequest
| Field Name | Type | Description |
|---|---|---|
| include_hash | bool | |
| filter | string |
ListSecretsResponse
| Field Name | Type | Description |
|---|---|---|
| secrets | repeated Secret |
PullSecretsRequest
| Field Name | Type | Description |
|---|---|---|
| include_hash | bool | |
| updates_only | bool |
PullSecretsResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated PullSecretsResponse.Change |
PullSecretsResponse.Change
| Field Name | Type | Description |
|---|---|---|
| change_time | google.protobuf.Timestamp | |
| secret | Secret |
CreateSecretRequest
| Field Name | Type | Description |
|---|---|---|
| secret | Secret |
VerifySecretRequest
| Field Name | Type | Description |
|---|---|---|
| tenant_id | string | |
| secret | string |
GetSecretRequest
| Field Name | Type | Description |
|---|---|---|
| id | string | |
| include_hash | bool |
GetSecretByHashRequest
| Field Name | Type | Description |
|---|---|---|
| secret_hash | bytes |
UpdateSecretRequest
| Field Name | Type | Description |
|---|---|---|
| secret | Secret |
DeleteSecretRequest
| Field Name | Type | Description |
|---|---|---|
| id | string |
DeleteSecretResponse
No fields defined.
PullSecretRequest
| Field Name | Type | Description |
|---|---|---|
| id | string | |
| include_hash | bool | |
| updates_only | bool |
PullSecretResponse
| Field Name | Type | Description |
|---|---|---|
| changes | repeated PullSecretResponse.Change |
PullSecretResponse.Change
| Field Name | Type | Description |
|---|---|---|
| change_time | google.protobuf.Timestamp | |
| secret | Secret |
RegenerateSecretRequest
| Field Name | Type | Description |
|---|---|---|
| id | string |