IAM
Service IAM
Permission Resource
Fields | |
---|---|
name | string |
Name of Permission Example: liquid.site.create | |
title | string |
Title | |
description | string |
Description |
rpc GetPermission(GetPermissionRequest) returns (Permission)
GetPermission
rpc BatchGetPermissions(BatchGetPermissionsRequest) returns (BatchGetPermissionsResponse)
BatchGetPermissions
rpc ListPermissions(ListPermissionsRequest) returns (ListPermissionsResponse)
ListPermissions
rpc WatchPermission(WatchPermissionRequest) returns (WatchPermissionResponse)
WatchPermission
rpc WatchPermissions(WatchPermissionsRequest) returns (WatchPermissionsResponse)
WatchPermissions
rpc CreatePermission(CreatePermissionRequest) returns (Permission)
CreatePermission
rpc UpdatePermission(UpdatePermissionRequest) returns (Permission)
UpdatePermission
rpc DeletePermission(DeletePermissionRequest) returns (Empty)
DeletePermission
rpc CheckPermissions(CheckPermissionsRequest) returns (CheckPermissionsResponse)
CheckPermissions
rpc CheckMyPermissions(CheckMyPermissionsRequest) returns (CheckMyPermissionsResponse)
CheckMyPermissions
Request message for method [GetPermission][ntt.iam.v1alpha.GetPermission]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Permission | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetPermissions][ntt.iam.v1alpha.BatchGetPermissions]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Permission | |
names | repeated string |
Names of Permissions | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetPermissionsResponse
Fields | |
---|---|
permissions | repeated Permission |
found Permissions | |
missing | repeated string |
list of not found Permissions |
Request message for method [ListPermissions][ntt.iam.v1alpha.ListPermissions]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Permissions than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListPermissionsResponse.next_page_token][ntt.iam.v1alpha.ListPermissionsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListPermissions][ntt.iam.v1alpha.ListPermissions]
Fields | |
---|---|
permissions | repeated Permission |
The list of Permissions | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListPermissionsRequest.page_token][ntt.iam.v1alpha.ListPermissionsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListPermissionsRequest.page_token][ntt.iam.v1alpha.ListPermissionsRequest.page_token] |
Request message for method [WatchPermission][ntt.iam.v1alpha.WatchPermission]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Permission | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchPermissionResponse
Fields | |
---|---|
change | PermissionChange |
Request message for method [WatchPermissions][ntt.iam.v1alpha.WatchPermissions]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Permissions than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Permission that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Permission that don't affect any of masked fields won't be sent back. |
WatchPermissionsResponse
Fields | |
---|---|
permission_changes | repeated PermissionChange |
Changes of Permissions | |
page_token_change | WatchPermissionsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreatePermission][ntt.iam.v1alpha.CreatePermission]
Fields | |
---|---|
permission | Permission |
Permission resource body |
Request message for method [UpdatePermission][ntt.iam.v1alpha.UpdatePermission]
Fields | |
---|---|
permission | Permission |
Permission resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeletePermission][ntt.iam.v1alpha.DeletePermission]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Permission |
Request message for method [CheckPermissions][ntt.iam.v1alpha.CheckPermissions]
Fields | |
---|---|
member | string |
Acting principal, e.g. user or service account Format of the string is one of:
| |
checks | repeated Check |
Checks | |
skip_cache | bool |
If true, server will skip checking permissions in cache |
Response message for method [CheckPermissions][ntt.iam.v1alpha.CheckPermissions]
Fields | |
---|---|
check_results | repeated CheckResult |
Request message for method [CheckMyPermissions][ntt.iam.v1alpha.CheckMyPermissions]
Fields | |
---|---|
checks | repeated Check |
Checks | |
skip_cache | bool |
If true, server will skip checking permissions in cache |
Response message for method [CheckMyPermissions][ntt.iam.v1alpha.CheckMyPermissions]
Fields | |
---|---|
check_results | repeated CheckResult |
Role is a named bag of [Permissions][ntt.iam.v1alpha.Permission] that can be granted on certain scope (system, organization or project) to member (user, service account, group, anyone) with [RoleBinding].
Note: currently roles are defined as system-level resources, but per-organization or per-project support is expected.
Fields | |
---|---|
name | string |
Name of Role | |
display_name | string |
Display Name | |
included_permissions | repeated string |
Included Permissions in this Role. Binding this role grants all following Permissions. | |
default_condition_binding | ConditionBinding |
Default conditionBinding (optional) |
rpc GetRole(GetRoleRequest) returns (Role)
GetRole
rpc BatchGetRoles(BatchGetRolesRequest) returns (BatchGetRolesResponse)
BatchGetRoles
rpc ListRoles(ListRolesRequest) returns (ListRolesResponse)
ListRoles
rpc WatchRole(WatchRoleRequest) returns (WatchRoleResponse)
WatchRole
rpc WatchRoles(WatchRolesRequest) returns (WatchRolesResponse)
WatchRoles
rpc CreateRole(CreateRoleRequest) returns (Role)
CreateRole
rpc UpdateRole(UpdateRoleRequest) returns (Role)
UpdateRole
rpc DeleteRole(DeleteRoleRequest) returns (Empty)
DeleteRole
Request message for method [GetRole][ntt.iam.v1alpha.GetRole]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Role | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetRoles][ntt.iam.v1alpha.BatchGetRoles]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Role | |
names | repeated string |
Names of Roles | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetRolesResponse
Fields | |
---|---|
roles | repeated Role |
found Roles | |
missing | repeated string |
list of not found Roles |
Request message for method [ListRoles][ntt.iam.v1alpha.ListRoles]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Roles than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListRolesResponse.next_page_token][ntt.iam.v1alpha.ListRolesResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListRoles][ntt.iam.v1alpha.ListRoles]
Fields | |
---|---|
roles | repeated Role |
The list of Roles | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListRolesRequest.page_token][ntt.iam.v1alpha.ListRolesRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListRolesRequest.page_token][ntt.iam.v1alpha.ListRolesRequest.page_token] |
Request message for method [WatchRole][ntt.iam.v1alpha.WatchRole]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Role | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchRoleResponse
Fields | |
---|---|
change | RoleChange |
Request message for method [WatchRoles][ntt.iam.v1alpha.WatchRoles]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Roles than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Role that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Role that don't affect any of masked fields won't be sent back. |
WatchRolesResponse
Fields | |
---|---|
role_changes | repeated RoleChange |
Changes of Roles | |
page_token_change | WatchRolesResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateRole][ntt.iam.v1alpha.CreateRole]
Fields | |
---|---|
role | Role |
Role resource body |
Request message for method [UpdateRole][ntt.iam.v1alpha.UpdateRole]
Fields | |
---|---|
role | Role |
Role resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteRole][ntt.iam.v1alpha.DeleteRole]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Role |
Organization represents higher-level organizational unit, like Company, University or Division
Organizations supports managing hierarchies with [Organization.parent_organization] field. All [Permission] grants through [RoleBinding]s are propagated from organization ancestors to their descendants.
Fields | |
---|---|
name | string |
Name of Organization | |
title | string |
Official Name of Organization | |
parent_organization | string |
Parent organization | |
root_organization | string |
Top parent (internal) | |
ancestry_path | repeated string |
Full ancestry path (internal) |
rpc GetOrganization(GetOrganizationRequest) returns (Organization)
GetOrganization
rpc BatchGetOrganizations(BatchGetOrganizationsRequest) returns (BatchGetOrganizationsResponse)
BatchGetOrganizations
rpc ListOrganizations(ListOrganizationsRequest) returns (ListOrganizationsResponse)
ListOrganizations
rpc WatchOrganization(WatchOrganizationRequest) returns (WatchOrganizationResponse)
WatchOrganization
rpc WatchOrganizations(WatchOrganizationsRequest) returns (WatchOrganizationsResponse)
WatchOrganizations
rpc CreateOrganization(CreateOrganizationRequest) returns (Organization)
CreateOrganization
rpc UpdateOrganization(UpdateOrganizationRequest) returns (Organization)
UpdateOrganization
rpc DeleteOrganization(DeleteOrganizationRequest) returns (Empty)
DeleteOrganization
rpc ListMyOrganizations(ListMyOrganizationsRequest) returns (ListMyOrganizationsResponse)
ListMyOrganizations
Request message for method [GetOrganization][ntt.iam.v1alpha.GetOrganization]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Organization | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetOrganizations][ntt.iam.v1alpha.BatchGetOrganizations]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Organization | |
names | repeated string |
Names of Organizations | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetOrganizationsResponse
Fields | |
---|---|
organizations | repeated Organization |
found Organizations | |
missing | repeated string |
list of not found Organizations |
Request message for method [ListOrganizations][ntt.iam.v1alpha.ListOrganizations]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Organizations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListOrganizationsResponse.next_page_token][ntt.iam.v1alpha.ListOrganizationsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListOrganizations][ntt.iam.v1alpha.ListOrganizations]
Fields | |
---|---|
organizations | repeated Organization |
The list of Organizations | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListOrganizationsRequest.page_token][ntt.iam.v1alpha.ListOrganizationsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListOrganizationsRequest.page_token][ntt.iam.v1alpha.ListOrganizationsRequest.page_token] |
Request message for method [WatchOrganization][ntt.iam.v1alpha.WatchOrganization]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Organization | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchOrganizationResponse
Fields | |
---|---|
change | OrganizationChange |
Request message for method [WatchOrganizations][ntt.iam.v1alpha.WatchOrganizations]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Organizations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Organization that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Organization that don't affect any of masked fields won't be sent back. |
WatchOrganizationsResponse
Fields | |
---|---|
organization_changes | repeated OrganizationChange |
Changes of Organizations | |
page_token_change | WatchOrganizationsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateOrganization][ntt.iam.v1alpha.CreateOrganization]
Fields | |
---|---|
organization | Organization |
Organization resource body |
Request message for method [UpdateOrganization][ntt.iam.v1alpha.UpdateOrganization]
Fields | |
---|---|
organization | Organization |
Organization resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteOrganization][ntt.iam.v1alpha.DeleteOrganization]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Organization |
Request message for method [ListMyOrganizations][ntt.iam.v1alpha.ListMyOrganizations]
Fields | |
---|---|
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A FieldMask used to filter response fields. When present, only requested fields will be present in each response item. Omitting field_mask results will cause response items to contain all present fields. |
Response message for method [ListMyOrganizations][ntt.iam.v1alpha.ListMyOrganizations]
Fields | |
---|---|
organizations | repeated Organization |
The list of Organizations |
Group Resource
Allows grouping members like: [ServiceAccounts][ntt.iam.v1alpha.ServiceAccount], [Users][ntt.iam.v1alpha.User], or other [Groups][ntt.iam.v1alpha.Group] by managing [memberships][ntt.iam.v1alpha.GroupMember].
Groups can then be used to simplify access management by referring to them through via [email][ntt.iam.v1alpha.Group.email] in [RoleBindings][ntt.iam.v1alpha.RoleBinding.member].
Fields | |
---|---|
name | string |
Name of Group | |
display_name | string |
Display Name | |
string | |
Unique email address for this [Group]. Generated based on its [name][ntt.iam.v1alpha.Group.name] with following rules:
This email can be used in [RoleBindings][ntt.iam.v1alpha.RoleBinding.member] field. Note: Currently there is way to assign custom domain for [Organization] or [Project]. |
rpc GetGroup(GetGroupRequest) returns (Group)
GetGroup
rpc BatchGetGroups(BatchGetGroupsRequest) returns (BatchGetGroupsResponse)
BatchGetGroups
rpc ListGroups(ListGroupsRequest) returns (ListGroupsResponse)
ListGroups
rpc WatchGroup(WatchGroupRequest) returns (WatchGroupResponse)
WatchGroup
rpc WatchGroups(WatchGroupsRequest) returns (WatchGroupsResponse)
WatchGroups
rpc CreateGroup(CreateGroupRequest) returns (Group)
CreateGroup
rpc UpdateGroup(UpdateGroupRequest) returns (Group)
UpdateGroup
rpc DeleteGroup(DeleteGroupRequest) returns (Empty)
DeleteGroup
Request message for method [GetGroup][ntt.iam.v1alpha.GetGroup]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Group | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetGroups][ntt.iam.v1alpha.BatchGetGroups]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Group | |
names | repeated string |
Names of Groups | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetGroupsResponse
Fields | |
---|---|
groups | repeated Group |
found Groups | |
missing | repeated string |
list of not found Groups |
Request message for method [ListGroups][ntt.iam.v1alpha.ListGroups]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.Group | |
page_size | int32 |
Requested page size. Server may return fewer Groups than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListGroupsResponse.next_page_token][ntt.iam.v1alpha.ListGroupsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListGroups][ntt.iam.v1alpha.ListGroups]
Fields | |
---|---|
groups | repeated Group |
The list of Groups | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListGroupsRequest.page_token][ntt.iam.v1alpha.ListGroupsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListGroupsRequest.page_token][ntt.iam.v1alpha.ListGroupsRequest.page_token] |
Request message for method [WatchGroup][ntt.iam.v1alpha.WatchGroup]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Group | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchGroupResponse
Fields | |
---|---|
change | GroupChange |
Request message for method [WatchGroups][ntt.iam.v1alpha.WatchGroups]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.Group | |
page_size | int32 |
Requested page size. Server may return fewer Groups than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Group that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Group that don't affect any of masked fields won't be sent back. |
WatchGroupsResponse
Fields | |
---|---|
group_changes | repeated GroupChange |
Changes of Groups | |
page_token_change | WatchGroupsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateGroup][ntt.iam.v1alpha.CreateGroup]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.Group | |
group | Group |
Group resource body |
Request message for method [UpdateGroup][ntt.iam.v1alpha.UpdateGroup]
Fields | |
---|---|
group | Group |
Group resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteGroup][ntt.iam.v1alpha.DeleteGroup]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Group |
GroupMember Resource
Fields | |
---|---|
name | string |
Name of GroupMember | |
member | string |
Format of the string is one of:
| |
owner_group | string |
Internal field presenting group owning this record if this member IS NOT direct member of parent group. For example, member X can be member of group A and group A can be member of group B. In result, member X also is a member of group B, but it's not owned by it - owner_group points to group A. If X is deleted from group A, then it's also deleted from group B. | |
member_ids_inclusions | bool |
This internal field is used for copies of GroupMember instances when member is of "group:" type. It contains minimal set of all member IDs (group:$email) that lie in the ancestry path of this copy. For example, group A belongs to group B and group B belongs to group C. In that case, group A also belongs to C via group B. In this case, group C has a GroupMember pointing to A and field member_ids_inclusions contains one item: member identifier of group B. member_ids_inclusions is used purely by iam controller to prevent cycles in group inheritance. |
rpc GetGroupMember(GetGroupMemberRequest) returns (GroupMember)
GetGroupMember
rpc BatchGetGroupMembers(BatchGetGroupMembersRequest) returns (BatchGetGroupMembersResponse)
BatchGetGroupMembers
rpc ListGroupMembers(ListGroupMembersRequest) returns (ListGroupMembersResponse)
ListGroupMembers
rpc WatchGroupMember(WatchGroupMemberRequest) returns (WatchGroupMemberResponse)
WatchGroupMember
rpc WatchGroupMembers(WatchGroupMembersRequest) returns (WatchGroupMembersResponse)
WatchGroupMembers
rpc CreateGroupMember(CreateGroupMemberRequest) returns (GroupMember)
CreateGroupMember
rpc UpdateGroupMember(UpdateGroupMemberRequest) returns (GroupMember)
UpdateGroupMember
rpc DeleteGroupMember(DeleteGroupMemberRequest) returns (Empty)
DeleteGroupMember
Request message for method [GetGroupMember][ntt.iam.v1alpha.GetGroupMember]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.GroupMember | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetGroupMembers][ntt.iam.v1alpha.BatchGetGroupMembers]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.GroupMember | |
names | repeated string |
Names of GroupMembers | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetGroupMembersResponse
Fields | |
---|---|
group_members | repeated GroupMember |
found GroupMembers | |
missing | repeated string |
list of not found GroupMembers |
Request message for method [ListGroupMembers][ntt.iam.v1alpha.ListGroupMembers]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.GroupMember | |
page_size | int32 |
Requested page size. Server may return fewer GroupMembers than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListGroupMembersResponse.next_page_token][ntt.iam.v1alpha.ListGroupMembersResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListGroupMembers][ntt.iam.v1alpha.ListGroupMembers]
Fields | |
---|---|
group_members | repeated GroupMember |
The list of GroupMembers | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListGroupMembersRequest.page_token][ntt.iam.v1alpha.ListGroupMembersRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListGroupMembersRequest.page_token][ntt.iam.v1alpha.ListGroupMembersRequest.page_token] |
Request message for method [WatchGroupMember][ntt.iam.v1alpha.WatchGroupMember]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.GroupMember | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchGroupMemberResponse
Fields | |
---|---|
change | GroupMemberChange |
Request message for method [WatchGroupMembers][ntt.iam.v1alpha.WatchGroupMembers]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.GroupMember | |
page_size | int32 |
Requested page size. Server may return fewer GroupMembers than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to GroupMember that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to GroupMember that don't affect any of masked fields won't be sent back. |
WatchGroupMembersResponse
Fields | |
---|---|
group_member_changes | repeated GroupMemberChange |
Changes of GroupMembers | |
page_token_change | WatchGroupMembersResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateGroupMember][ntt.iam.v1alpha.CreateGroupMember]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.GroupMember | |
group_member | GroupMember |
GroupMember resource body |
Request message for method [UpdateGroupMember][ntt.iam.v1alpha.UpdateGroupMember]
Fields | |
---|---|
group_member | GroupMember |
GroupMember resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteGroupMember][ntt.iam.v1alpha.DeleteGroupMember]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.GroupMember |
OrganizationInvitation Resource
Fields | |
---|---|
name | string |
Name of OrganizationInvitation | |
invitation | Invitation |
rpc GetOrganizationInvitation(GetOrganizationInvitationRequest) returns (OrganizationInvitation)
GetOrganizationInvitation
rpc BatchGetOrganizationInvitations(BatchGetOrganizationInvitationsRequest) returns (BatchGetOrganizationInvitationsResponse)
BatchGetOrganizationInvitations
rpc ListOrganizationInvitations(ListOrganizationInvitationsRequest) returns (ListOrganizationInvitationsResponse)
ListOrganizationInvitations
rpc WatchOrganizationInvitation(WatchOrganizationInvitationRequest) returns (WatchOrganizationInvitationResponse)
WatchOrganizationInvitation
rpc WatchOrganizationInvitations(WatchOrganizationInvitationsRequest) returns (WatchOrganizationInvitationsResponse)
WatchOrganizationInvitations
rpc CreateOrganizationInvitation(CreateOrganizationInvitationRequest) returns (OrganizationInvitation)
CreateOrganizationInvitation
rpc UpdateOrganizationInvitation(UpdateOrganizationInvitationRequest) returns (OrganizationInvitation)
UpdateOrganizationInvitation
rpc DeleteOrganizationInvitation(DeleteOrganizationInvitationRequest) returns (Empty)
DeleteOrganizationInvitation
rpc AcceptOrganizationInvitation(AcceptOrganizationInvitationRequest) returns (AcceptOrganizationInvitationResponse)
AcceptOrganizationInvitation
rpc DeclineOrganizationInvitation(DeclineOrganizationInvitationRequest) returns (DeclineOrganizationInvitationResponse)
DeclineOrganizationInvitation
rpc ListMyOrganizationInvitations(ListMyOrganizationInvitationsRequest) returns (ListMyOrganizationInvitationsResponse)
ListMyOrganizationInvitations
Request message for method [GetOrganizationInvitation][ntt.iam.v1alpha.GetOrganizationInvitation]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.OrganizationInvitation | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetOrganizationInvitations][ntt.iam.v1alpha.BatchGetOrganizationInvitations]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.OrganizationInvitation | |
names | repeated string |
Names of OrganizationInvitations | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetOrganizationInvitationsResponse
Fields | |
---|---|
organization_invitations | repeated OrganizationInvitation |
found OrganizationInvitations | |
missing | repeated string |
list of not found OrganizationInvitations |
Request message for method [ListOrganizationInvitations][ntt.iam.v1alpha.ListOrganizationInvitations]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.OrganizationInvitation | |
page_size | int32 |
Requested page size. Server may return fewer OrganizationInvitations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListOrganizationInvitationsResponse.next_page_token][ntt.iam.v1alpha.ListOrganizationInvitationsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListOrganizationInvitations][ntt.iam.v1alpha.ListOrganizationInvitations]
Fields | |
---|---|
organization_invitations | repeated OrganizationInvitation |
The list of OrganizationInvitations | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListOrganizationInvitationsRequest.page_token][ntt.iam.v1alpha.ListOrganizationInvitationsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListOrganizationInvitationsRequest.page_token][ntt.iam.v1alpha.ListOrganizationInvitationsRequest.page_token] |
Request message for method [WatchOrganizationInvitation][ntt.iam.v1alpha.WatchOrganizationInvitation]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.OrganizationInvitation | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchOrganizationInvitationResponse
Fields | |
---|---|
change | OrganizationInvitationChange |
Request message for method [WatchOrganizationInvitations][ntt.iam.v1alpha.WatchOrganizationInvitations]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.OrganizationInvitation | |
page_size | int32 |
Requested page size. Server may return fewer OrganizationInvitations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to OrganizationInvitation that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to OrganizationInvitation that don't affect any of masked fields won't be sent back. |
WatchOrganizationInvitationsResponse
Fields | |
---|---|
organization_invitation_changes | repeated OrganizationInvitationChange |
Changes of OrganizationInvitations | |
page_token_change | WatchOrganizationInvitationsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateOrganizationInvitation][ntt.iam.v1alpha.CreateOrganizationInvitation]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.OrganizationInvitation | |
organization_invitation | OrganizationInvitation |
OrganizationInvitation resource body |
Request message for method [UpdateOrganizationInvitation][ntt.iam.v1alpha.UpdateOrganizationInvitation]
Fields | |
---|---|
organization_invitation | OrganizationInvitation |
OrganizationInvitation resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteOrganizationInvitation][ntt.iam.v1alpha.DeleteOrganizationInvitation]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.OrganizationInvitation |
Request message for method [AcceptOrganizationInvitation][ntt.iam.v1alpha.AcceptOrganizationInvitation]
Fields | |
---|---|
name | string |
Name of OrganizationInvitation_Reference |
Response message for method [AcceptOrganizationInvitation][ntt.iam.v1alpha.AcceptOrganizationInvitation]
Fields | |
---|---|
none |
Request message for method [DeclineOrganizationInvitation][ntt.iam.v1alpha.DeclineOrganizationInvitation]
Fields | |
---|---|
name | string |
Name of OrganizationInvitation_Reference | |
filter | string |
Additional filter for invitations, e.g. state = "PENDING" |
Response message for method [DeclineOrganizationInvitation][ntt.iam.v1alpha.DeclineOrganizationInvitation]
Fields | |
---|---|
none |
Request message for method [ListMyInvitations][ntt.iam.ListMyInvitations]
Fields | |
---|---|
parent | string |
Name of Organization_Reference | |
filter | string |
Additional filter for invitations, e.g. state = "PENDING" |
Response message for method [ListMyOrganizationInvitations][ntt.iam.v1alpha.ListMyOrganizationInvitations]
Fields | |
---|---|
organization_invitations | repeated OrganizationInvitation |
The list of OrganizationInvitations |
Project Resource
Fields | |
---|---|
name | string |
Name of Project | |
title | string |
Title | |
parent_organization | string |
Parent organization | |
root_organization | string |
Top parent | |
ancestry_path | repeated string |
Full ancestry path |
rpc GetProject(GetProjectRequest) returns (Project)
GetProject
rpc BatchGetProjects(BatchGetProjectsRequest) returns (BatchGetProjectsResponse)
BatchGetProjects
rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse)
ListProjects
rpc WatchProject(WatchProjectRequest) returns (WatchProjectResponse)
WatchProject
rpc WatchProjects(WatchProjectsRequest) returns (WatchProjectsResponse)
WatchProjects
rpc CreateProject(CreateProjectRequest) returns (Project)
CreateProject
rpc UpdateProject(UpdateProjectRequest) returns (Project)
UpdateProject
rpc DeleteProject(DeleteProjectRequest) returns (Empty)
DeleteProject
rpc ListMyProjects(ListMyProjectsRequest) returns (ListMyProjectsResponse)
ListMyProjects
Request message for method [GetProject][ntt.iam.v1alpha.GetProject]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Project | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetProjects][ntt.iam.v1alpha.BatchGetProjects]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Project | |
names | repeated string |
Names of Projects | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetProjectsResponse
Fields | |
---|---|
projects | repeated Project |
found Projects | |
missing | repeated string |
list of not found Projects |
Request message for method [ListProjects][ntt.iam.v1alpha.ListProjects]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListProjectsResponse.next_page_token][ntt.iam.v1alpha.ListProjectsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListProjects][ntt.iam.v1alpha.ListProjects]
Fields | |
---|---|
projects | repeated Project |
The list of Projects | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.iam.v1alpha.ListProjectsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.iam.v1alpha.ListProjectsRequest.page_token] |
Request message for method [WatchProject][ntt.iam.v1alpha.WatchProject]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Project | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchProjectResponse
Fields | |
---|---|
change | ProjectChange |
Request message for method [WatchProjects][ntt.iam.v1alpha.WatchProjects]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Project that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Project that don't affect any of masked fields won't be sent back. |
WatchProjectsResponse
Fields | |
---|---|
project_changes | repeated ProjectChange |
Changes of Projects | |
page_token_change | WatchProjectsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateProject][ntt.iam.v1alpha.CreateProject]
Fields | |
---|---|
project | Project |
Project resource body |
Request message for method [UpdateProject][ntt.iam.v1alpha.UpdateProject]
Fields | |
---|---|
project | Project |
Project resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteProject][ntt.iam.v1alpha.DeleteProject]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Project |
Request message for method [ListMyProjects][ntt.iam.v1alpha.ListMyProjects]
Fields | |
---|---|
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A FieldMask used to filter response fields. When present, only requested fields will be present in each response item. Omitting field_mask results will cause response items to contain all present fields. |
Response message for method [ListMyProjects][ntt.iam.v1alpha.ListMyProjects]
Fields | |
---|---|
projects | repeated Project |
The list of Projects |
ServiceAccount Resource
Fields | |
---|---|
name | string |
Name of ServiceAccount | |
display_name | string |
Display Name |
rpc GetServiceAccount(GetServiceAccountRequest) returns (ServiceAccount)
GetServiceAccount
rpc BatchGetServiceAccounts(BatchGetServiceAccountsRequest) returns (BatchGetServiceAccountsResponse)
BatchGetServiceAccounts
rpc ListServiceAccounts(ListServiceAccountsRequest) returns (ListServiceAccountsResponse)
ListServiceAccounts
rpc WatchServiceAccount(WatchServiceAccountRequest) returns (WatchServiceAccountResponse)
WatchServiceAccount
rpc WatchServiceAccounts(WatchServiceAccountsRequest) returns (WatchServiceAccountsResponse)
WatchServiceAccounts
rpc CreateServiceAccount(CreateServiceAccountRequest) returns (ServiceAccount)
CreateServiceAccount
rpc UpdateServiceAccount(UpdateServiceAccountRequest) returns (ServiceAccount)
UpdateServiceAccount
rpc DeleteServiceAccount(DeleteServiceAccountRequest) returns (Empty)
DeleteServiceAccount
Request message for method [GetServiceAccount][ntt.iam.v1alpha.GetServiceAccount]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ServiceAccount | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetServiceAccounts][ntt.iam.v1alpha.BatchGetServiceAccounts]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.ServiceAccount | |
names | repeated string |
Names of ServiceAccounts | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetServiceAccountsResponse
Fields | |
---|---|
service_accounts | repeated ServiceAccount |
found ServiceAccounts | |
missing | repeated string |
list of not found ServiceAccounts |
Request message for method [ListServiceAccounts][ntt.iam.v1alpha.ListServiceAccounts]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.ServiceAccount | |
page_size | int32 |
Requested page size. Server may return fewer ServiceAccounts than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListServiceAccountsResponse.next_page_token][ntt.iam.v1alpha.ListServiceAccountsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListServiceAccounts][ntt.iam.v1alpha.ListServiceAccounts]
Fields | |
---|---|
service_accounts | repeated ServiceAccount |
The list of ServiceAccounts | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListServiceAccountsRequest.page_token][ntt.iam.v1alpha.ListServiceAccountsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListServiceAccountsRequest.page_token][ntt.iam.v1alpha.ListServiceAccountsRequest.page_token] |
Request message for method [WatchServiceAccount][ntt.iam.v1alpha.WatchServiceAccount]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.ServiceAccount | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchServiceAccountResponse
Fields | |
---|---|
change | ServiceAccountChange |
Request message for method [WatchServiceAccounts][ntt.iam.v1alpha.WatchServiceAccounts]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ServiceAccount | |
page_size | int32 |
Requested page size. Server may return fewer ServiceAccounts than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ServiceAccount that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ServiceAccount that don't affect any of masked fields won't be sent back. |
WatchServiceAccountsResponse
Fields | |
---|---|
service_account_changes | repeated ServiceAccountChange |
Changes of ServiceAccounts | |
page_token_change | WatchServiceAccountsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateServiceAccount][ntt.iam.v1alpha.CreateServiceAccount]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ServiceAccount | |
service_account | ServiceAccount |
ServiceAccount resource body |
Request message for method [UpdateServiceAccount][ntt.iam.v1alpha.UpdateServiceAccount]
Fields | |
---|---|
service_account | ServiceAccount |
ServiceAccount resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteServiceAccount][ntt.iam.v1alpha.DeleteServiceAccount]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ServiceAccount |
Represents a key pair for the service account
Fields | |
---|---|
name | string |
Name of ServiceAccountKey | |
display_name | string |
Display name | |
public_key_data | string |
Public key contents | |
private_key_data | string |
The private key of the pair. This field is only provided in CreateServiceAccountKey responses. Private keys are NOT stored on the server. | |
algorithm | ServiceAccountKey.Algorithm |
The algorithm used to generate the key. | |
valid_not_before | .google.protobuf.Timestamp |
The key is not valid before this timestamp. | |
valid_not_after | .google.protobuf.Timestamp |
The key is not valid after this timestamp. |
rpc GetServiceAccountKey(GetServiceAccountKeyRequest) returns (ServiceAccountKey)
GetServiceAccountKey
rpc BatchGetServiceAccountKeys(BatchGetServiceAccountKeysRequest) returns (BatchGetServiceAccountKeysResponse)
BatchGetServiceAccountKeys
rpc ListServiceAccountKeys(ListServiceAccountKeysRequest) returns (ListServiceAccountKeysResponse)
ListServiceAccountKeys
rpc WatchServiceAccountKey(WatchServiceAccountKeyRequest) returns (WatchServiceAccountKeyResponse)
WatchServiceAccountKey
rpc WatchServiceAccountKeys(WatchServiceAccountKeysRequest) returns (WatchServiceAccountKeysResponse)
WatchServiceAccountKeys
rpc CreateServiceAccountKey(CreateServiceAccountKeyRequest) returns (ServiceAccountKey)
CreateServiceAccountKey
rpc UpdateServiceAccountKey(UpdateServiceAccountKeyRequest) returns (ServiceAccountKey)
UpdateServiceAccountKey
rpc DeleteServiceAccountKey(DeleteServiceAccountKeyRequest) returns (Empty)
DeleteServiceAccountKey
Request message for method [GetServiceAccountKey][ntt.iam.v1alpha.GetServiceAccountKey]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ServiceAccountKey | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetServiceAccountKeys][ntt.iam.v1alpha.BatchGetServiceAccountKeys]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.ServiceAccountKey | |
names | repeated string |
Names of ServiceAccountKeys | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetServiceAccountKeysResponse
Fields | |
---|---|
service_account_keys | repeated ServiceAccountKey |
found ServiceAccountKeys | |
missing | repeated string |
list of not found ServiceAccountKeys |
Request message for method [ListServiceAccountKeys][ntt.iam.v1alpha.ListServiceAccountKeys]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.ServiceAccountKey | |
page_size | int32 |
Requested page size. Server may return fewer ServiceAccountKeys than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListServiceAccountKeysResponse.next_page_token][ntt.iam.v1alpha.ListServiceAccountKeysResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListServiceAccountKeys][ntt.iam.v1alpha.ListServiceAccountKeys]
Fields | |
---|---|
service_account_keys | repeated ServiceAccountKey |
The list of ServiceAccountKeys | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListServiceAccountKeysRequest.page_token][ntt.iam.v1alpha.ListServiceAccountKeysRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListServiceAccountKeysRequest.page_token][ntt.iam.v1alpha.ListServiceAccountKeysRequest.page_token] |
Request message for method [WatchServiceAccountKey][ntt.iam.v1alpha.WatchServiceAccountKey]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.ServiceAccountKey | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchServiceAccountKeyResponse
Fields | |
---|---|
change | ServiceAccountKeyChange |
Request message for method [WatchServiceAccountKeys][ntt.iam.v1alpha.WatchServiceAccountKeys]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ServiceAccountKey | |
page_size | int32 |
Requested page size. Server may return fewer ServiceAccountKeys than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ServiceAccountKey that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ServiceAccountKey that don't affect any of masked fields won't be sent back. |
WatchServiceAccountKeysResponse
Fields | |
---|---|
service_account_key_changes | repeated ServiceAccountKeyChange |
Changes of ServiceAccountKeys | |
page_token_change | WatchServiceAccountKeysResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateServiceAccountKey][ntt.iam.v1alpha.CreateServiceAccountKey]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ServiceAccountKey | |
service_account_key | ServiceAccountKey |
ServiceAccountKey resource body |
Request message for method [UpdateServiceAccountKey][ntt.iam.v1alpha.UpdateServiceAccountKey]
Fields | |
---|---|
service_account_key | ServiceAccountKey |
ServiceAccountKey resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteServiceAccountKey][ntt.iam.v1alpha.DeleteServiceAccountKey]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ServiceAccountKey |
Values | |
---|---|
KEY_ALGORITHM_UNSPECIFIED | |
RSA_1024 | |
RSA_2048 | |
RSA_4096 | |
ProjectInvitation Resource
Fields | |
---|---|
name | string |
Name of ProjectInvitation | |
invitation | Invitation |
rpc GetProjectInvitation(GetProjectInvitationRequest) returns (ProjectInvitation)
GetProjectInvitation
rpc BatchGetProjectInvitations(BatchGetProjectInvitationsRequest) returns (BatchGetProjectInvitationsResponse)
BatchGetProjectInvitations
rpc ListProjectInvitations(ListProjectInvitationsRequest) returns (ListProjectInvitationsResponse)
ListProjectInvitations
rpc WatchProjectInvitation(WatchProjectInvitationRequest) returns (WatchProjectInvitationResponse)
WatchProjectInvitation
rpc WatchProjectInvitations(WatchProjectInvitationsRequest) returns (WatchProjectInvitationsResponse)
WatchProjectInvitations
rpc CreateProjectInvitation(CreateProjectInvitationRequest) returns (ProjectInvitation)
CreateProjectInvitation
rpc UpdateProjectInvitation(UpdateProjectInvitationRequest) returns (ProjectInvitation)
UpdateProjectInvitation
rpc DeleteProjectInvitation(DeleteProjectInvitationRequest) returns (Empty)
DeleteProjectInvitation
rpc AcceptProjectInvitation(AcceptProjectInvitationRequest) returns (AcceptProjectInvitationResponse)
AcceptProjectInvitation
rpc DeclineProjectInvitation(DeclineProjectInvitationRequest) returns (DeclineProjectInvitationResponse)
DeclineProjectInvitation
rpc ListMyProjectInvitations(ListMyProjectInvitationsRequest) returns (ListMyProjectInvitationsResponse)
ListMyProjectInvitations
Request message for method [GetProjectInvitation][ntt.iam.v1alpha.GetProjectInvitation]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ProjectInvitation | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetProjectInvitations][ntt.iam.v1alpha.BatchGetProjectInvitations]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.ProjectInvitation | |
names | repeated string |
Names of ProjectInvitations | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetProjectInvitationsResponse
Fields | |
---|---|
project_invitations | repeated ProjectInvitation |
found ProjectInvitations | |
missing | repeated string |
list of not found ProjectInvitations |
Request message for method [ListProjectInvitations][ntt.iam.v1alpha.ListProjectInvitations]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.ProjectInvitation | |
page_size | int32 |
Requested page size. Server may return fewer ProjectInvitations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListProjectInvitationsResponse.next_page_token][ntt.iam.v1alpha.ListProjectInvitationsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListProjectInvitations][ntt.iam.v1alpha.ListProjectInvitations]
Fields | |
---|---|
project_invitations | repeated ProjectInvitation |
The list of ProjectInvitations | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListProjectInvitationsRequest.page_token][ntt.iam.v1alpha.ListProjectInvitationsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListProjectInvitationsRequest.page_token][ntt.iam.v1alpha.ListProjectInvitationsRequest.page_token] |
Request message for method [WatchProjectInvitation][ntt.iam.v1alpha.WatchProjectInvitation]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.ProjectInvitation | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchProjectInvitationResponse
Fields | |
---|---|
change | ProjectInvitationChange |
Request message for method [WatchProjectInvitations][ntt.iam.v1alpha.WatchProjectInvitations]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ProjectInvitation | |
page_size | int32 |
Requested page size. Server may return fewer ProjectInvitations than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProjectInvitation that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProjectInvitation that don't affect any of masked fields won't be sent back. |
WatchProjectInvitationsResponse
Fields | |
---|---|
project_invitation_changes | repeated ProjectInvitationChange |
Changes of ProjectInvitations | |
page_token_change | WatchProjectInvitationsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateProjectInvitation][ntt.iam.v1alpha.CreateProjectInvitation]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.ProjectInvitation | |
project_invitation | ProjectInvitation |
ProjectInvitation resource body |
Request message for method [UpdateProjectInvitation][ntt.iam.v1alpha.UpdateProjectInvitation]
Fields | |
---|---|
project_invitation | ProjectInvitation |
ProjectInvitation resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteProjectInvitation][ntt.iam.v1alpha.DeleteProjectInvitation]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.ProjectInvitation |
Request message for method [AcceptProjectInvitation][ntt.iam.v1alpha.AcceptProjectInvitation]
Fields | |
---|---|
name | string |
Name of ProjectInvitation_Reference |
Response message for method [AcceptProjectInvitation][ntt.iam.v1alpha.AcceptProjectInvitation]
Fields | |
---|---|
none |
Request message for method [DeclineProjectInvitation][ntt.iam.v1alpha.DeclineProjectInvitation]
Fields | |
---|---|
name | string |
Name of ProjectInvitation_Reference |
Response message for method [DeclineProjectInvitation][ntt.iam.v1alpha.DeclineProjectInvitation]
Fields | |
---|---|
none |
Request message for method [ListMyProjectInvitations][ntt.iam.v1alpha.ListMyProjectInvitations]
Fields | |
---|---|
parent | string |
Name of Project_Reference | |
filter | string |
Additional filter for invitations, e.g. state = "PENDING" |
Response message for method [ListMyProjectInvitations][ntt.iam.v1alpha.ListMyProjectInvitations]
Fields | |
---|---|
project_invitations | repeated ProjectInvitation |
The list of ProjectInvitations |
User Resource
Fields | |
---|---|
name | string |
Name of User | |
full_name | string |
Full Name | |
string | |
email_verified | bool |
Is email verified | |
auth_info | User.AuthInfo |
refreshed_time | .google.protobuf.Timestamp |
rpc GetUser(GetUserRequest) returns (User)
GetUser
rpc BatchGetUsers(BatchGetUsersRequest) returns (BatchGetUsersResponse)
BatchGetUsers
rpc ListUsers(ListUsersRequest) returns (ListUsersResponse)
ListUsers
rpc WatchUser(WatchUserRequest) returns (WatchUserResponse)
WatchUser
rpc WatchUsers(WatchUsersRequest) returns (WatchUsersResponse)
WatchUsers
rpc CreateUser(CreateUserRequest) returns (User)
CreateUser
rpc UpdateUser(UpdateUserRequest) returns (User)
UpdateUser
rpc DeleteUser(DeleteUserRequest) returns (Empty)
DeleteUser
rpc GetUserByEmail(GetUserByEmailRequest) returns (User)
GetUserByEmail
rpc BatchGetUsersByEmail(BatchGetUsersByEmailRequest) returns (BatchGetUsersByEmailResponse)
BatchGetUsersByEmail
rpc RefreshUserFromIdToken(RefreshUserFromIdTokenRequest) returns (RefreshUserFromIdTokenResponse)
RefreshUserFromIdToken
Fields | |
---|---|
provider | string |
auth provider | |
id | string |
auth provider id |
Request message for method [GetUser][ntt.iam.v1alpha.GetUser]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.User | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetUsers][ntt.iam.v1alpha.BatchGetUsers]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.User | |
names | repeated string |
Names of Users | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetUsersResponse
Fields | |
---|---|
users | repeated User |
found Users | |
missing | repeated string |
list of not found Users |
Request message for method [ListUsers][ntt.iam.v1alpha.ListUsers]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Users than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListUsersResponse.next_page_token][ntt.iam.v1alpha.ListUsersResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListUsers][ntt.iam.v1alpha.ListUsers]
Fields | |
---|---|
users | repeated User |
The list of Users | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListUsersRequest.page_token][ntt.iam.v1alpha.ListUsersRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListUsersRequest.page_token][ntt.iam.v1alpha.ListUsersRequest.page_token] |
Request message for method [WatchUser][ntt.iam.v1alpha.WatchUser]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.User | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchUserResponse
Fields | |
---|---|
change | UserChange |
Request message for method [WatchUsers][ntt.iam.v1alpha.WatchUsers]
Fields | |
---|---|
page_size | int32 |
Requested page size. Server may return fewer Users than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to User that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to User that don't affect any of masked fields won't be sent back. |
WatchUsersResponse
Fields | |
---|---|
user_changes | repeated UserChange |
Changes of Users | |
page_token_change | WatchUsersResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateUser][ntt.iam.v1alpha.CreateUser]
Fields | |
---|---|
user | User |
User resource body |
Request message for method [UpdateUser][ntt.iam.v1alpha.UpdateUser]
Fields | |
---|---|
user | User |
User resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteUser][ntt.iam.v1alpha.DeleteUser]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.User |
Request message for method [GetUserByEmail][ntt.iam.v1alpha.GetUserByEmail]
Fields | |
---|---|
string | |
reference of ntt.iam.v1alpha.User | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetUsersByEmail][ntt.iam.v1alpha.BatchGetUsersByEmail]
Fields | |
---|---|
emails | repeated string |
Emails of users | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Response message for method [BatchGetUsersByEmail][ntt.iam.v1alpha.BatchGetUsersByEmail]
Fields | |
---|---|
users | repeated User |
found Users | |
missing | repeated string |
list of not found user emails |
Request message for method [RefreshUserFromIdToken][ntt.iam.v1alpha.RefreshUserFromIdToken]
Fields | |
---|---|
id_token | string |
JWT-encoded ID token |
Response message for method [RefreshUserFromIdToken][ntt.iam.v1alpha.RefreshUserFromIdToken]
Fields | |
---|---|
none |
RoleBinding in iam RBAC model is the way of granting access to a party (user, service account, etc) to edgelq resources. Creating RoleBinding requires user to answer 3 questions:
Who: with member field, e.g. "user:wile.e.coyote@customers.acme.com" What: specify scope (or parent), e.g.: projects/acme/roleBindings/<uuid>
How: bind role and optional condition to grant access to resources within above scope
RoleBindings are additive, meaning that creating a new RoleBinding may only extend ability of given member to perform actions. In other words RoleBinding doesn't affect other RoleBindings and [PermissionCheck][ntt.iam.v1alpha.PermissionCheck] method needs to find any RoleBinding granting permission
Fields | |
---|---|
name | string |
Name of RoleBinding | |
role | string |
Role | |
member | string |
Binding members Format of the string is one of:
| |
role_binding_inheritance | RoleBinding.RoleBindingInheritance |
Used by IAM controller to note role binding that has been created from another (parent) role binding. | |
condition_binding | ConditionBinding |
optional ConditionBinding |
rpc GetRoleBinding(GetRoleBindingRequest) returns (RoleBinding)
GetRoleBinding
rpc BatchGetRoleBindings(BatchGetRoleBindingsRequest) returns (BatchGetRoleBindingsResponse)
BatchGetRoleBindings
rpc ListRoleBindings(ListRoleBindingsRequest) returns (ListRoleBindingsResponse)
ListRoleBindings
rpc WatchRoleBinding(WatchRoleBindingRequest) returns (WatchRoleBindingResponse)
WatchRoleBinding
rpc WatchRoleBindings(WatchRoleBindingsRequest) returns (WatchRoleBindingsResponse)
WatchRoleBindings
rpc CreateRoleBinding(CreateRoleBindingRequest) returns (RoleBinding)
CreateRoleBinding
rpc UpdateRoleBinding(UpdateRoleBindingRequest) returns (RoleBinding)
UpdateRoleBinding
rpc DeleteRoleBinding(DeleteRoleBindingRequest) returns (Empty)
DeleteRoleBinding
Provides information about inheritance of this role binding - if it was created from another role binding.
Fields | |
---|---|
is_inherited | bool |
Indicates if role binding has parent. If value is false, role_binding_parent is NULL | |
role_binding_parent | string |
Role bindings which have group as member have child for each service account and user in that group. All those role bindings have one common parent pointing at group role binding TODO: CASCADE_DELETE to be replaced with some ASYNC CASCADE_DELETE |
Request message for method [GetRoleBinding][ntt.iam.v1alpha.GetRoleBinding]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.RoleBinding | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetRoleBindings][ntt.iam.v1alpha.BatchGetRoleBindings]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.RoleBinding | |
names | repeated string |
Names of RoleBindings | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetRoleBindingsResponse
Fields | |
---|---|
role_bindings | repeated RoleBinding |
found RoleBindings | |
missing | repeated string |
list of not found RoleBindings |
Request message for method [ListRoleBindings][ntt.iam.v1alpha.ListRoleBindings]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.RoleBinding | |
page_size | int32 |
Requested page size. Server may return fewer RoleBindings than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListRoleBindingsResponse.next_page_token][ntt.iam.v1alpha.ListRoleBindingsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListRoleBindings][ntt.iam.v1alpha.ListRoleBindings]
Fields | |
---|---|
role_bindings | repeated RoleBinding |
The list of RoleBindings | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListRoleBindingsRequest.page_token][ntt.iam.v1alpha.ListRoleBindingsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListRoleBindingsRequest.page_token][ntt.iam.v1alpha.ListRoleBindingsRequest.page_token] |
Request message for method [WatchRoleBinding][ntt.iam.v1alpha.WatchRoleBinding]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.RoleBinding | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchRoleBindingResponse
Fields | |
---|---|
change | RoleBindingChange |
Request message for method [WatchRoleBindings][ntt.iam.v1alpha.WatchRoleBindings]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.RoleBinding | |
page_size | int32 |
Requested page size. Server may return fewer RoleBindings than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to RoleBinding that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to RoleBinding that don't affect any of masked fields won't be sent back. |
WatchRoleBindingsResponse
Fields | |
---|---|
role_binding_changes | repeated RoleBindingChange |
Changes of RoleBindings | |
page_token_change | WatchRoleBindingsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateRoleBinding][ntt.iam.v1alpha.CreateRoleBinding]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.RoleBinding | |
role_binding | RoleBinding |
RoleBinding resource body |
Request message for method [UpdateRoleBinding][ntt.iam.v1alpha.UpdateRoleBinding]
Fields | |
---|---|
role_binding | RoleBinding |
RoleBinding resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteRoleBinding][ntt.iam.v1alpha.DeleteRoleBinding]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.RoleBinding |
Condition Resource provides an extension to primary RBAC model, which allows customizable (scriptable) access. Conditions can only be used to further limit (or narrow) access compared to standard (or unconditional) RBAC.
Usage:
When checking for principal access (anonymous, user, service account), for RoleBinding to grant permissions included in bound [Role], both RBAC and Condition expression evaluation must grant access.
Fields | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name | string | |||||||||||||||||||
Name of Condition | ||||||||||||||||||||
display_name | string | |||||||||||||||||||
Display Name | ||||||||||||||||||||
description | string | |||||||||||||||||||
Description | ||||||||||||||||||||
expression | string | |||||||||||||||||||
Condition expression in Google CEL, syntax, e.g. Accessible parameters:
Extension: Some Filter. Access is determined by the return value. Return | ||||||||||||||||||||
parameter_declarations | repeated Condition.ParameterDeclaration | |||||||||||||||||||
Typed parameters declarations. When binding a Condition passed parameters must correspond to declarations. |
rpc GetCondition(GetConditionRequest) returns (Condition)
GetCondition
rpc BatchGetConditions(BatchGetConditionsRequest) returns (BatchGetConditionsResponse)
BatchGetConditions
rpc ListConditions(ListConditionsRequest) returns (ListConditionsResponse)
ListConditions
rpc WatchCondition(WatchConditionRequest) returns (WatchConditionResponse)
WatchCondition
rpc WatchConditions(WatchConditionsRequest) returns (WatchConditionsResponse)
WatchConditions
rpc CreateCondition(CreateConditionRequest) returns (Condition)
CreateCondition
rpc UpdateCondition(UpdateConditionRequest) returns (Condition)
UpdateCondition
rpc DeleteCondition(DeleteConditionRequest) returns (Empty)
DeleteCondition
Parameter Declarations used
Fields | |
---|---|
key | string |
Parameter Key - must be unique within condition. Defined parameter variables are accessible in condition expression via | |
type | Condition.ParameterType |
Parameter value type |
Request message for method [GetCondition][ntt.iam.v1alpha.GetCondition]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Condition | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [BatchGetConditions][ntt.iam.v1alpha.BatchGetConditions]
Fields | |
---|---|
parent | string |
Optional parent ntt.iam.v1alpha.Condition | |
names | repeated string |
Names of Conditions | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
BatchGetConditionsResponse
Fields | |
---|---|
conditions | repeated Condition |
found Conditions | |
missing | repeated string |
list of not found Conditions |
Request message for method [ListConditions][ntt.iam.v1alpha.ListConditions]
Fields | |
---|---|
parent | string |
Parent name of ntt.iam.v1alpha.Condition | |
page_size | int32 |
Requested page size. Server may return fewer Conditions than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. Typically, this is the value of [ListConditionsResponse.next_page_token][ntt.iam.v1alpha.ListConditionsResponse.next_page_token] | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme" | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask | |
skip_cache | bool |
If true, server will skip checking if query result is present in it's cache |
Request message for method [ListConditions][ntt.iam.v1alpha.ListConditions]
Fields | |
---|---|
conditions | repeated Condition |
The list of Conditions | |
prev_page_token | string |
A token to retrieve previous page of results. Pass this value in the [ListConditionsRequest.page_token][ntt.iam.v1alpha.ListConditionsRequest.page_token] | |
next_page_token | string |
A token to retrieve next page of results. Pass this value in the [ListConditionsRequest.page_token][ntt.iam.v1alpha.ListConditionsRequest.page_token] |
Request message for method [WatchCondition][ntt.iam.v1alpha.WatchCondition]
Fields | |
---|---|
name | string |
Reference to ntt.iam.v1alpha.Condition | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask |
WatchConditionResponse
Fields | |
---|---|
change | ConditionChange |
Request message for method [WatchConditions][ntt.iam.v1alpha.WatchConditions]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.Condition | |
page_size | int32 |
Requested page size. Server may return fewer Conditions than requested. If unspecified, server will pick an appropriate default. | |
page_token | string |
A token identifying a page of results the server should return. | |
order_by | string |
Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination | |
filter | string |
Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")' | |
field_mask | .google.protobuf.FieldMask |
A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Condition that don't affect any of masked fields won't be sent back. | |
view | .goten.view.View |
View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Condition that don't affect any of masked fields won't be sent back. |
WatchConditionsResponse
Fields | |
---|---|
condition_changes | repeated ConditionChange |
Changes of Conditions | |
page_token_change | WatchConditionsResponse.PageTokenChange |
When present, PageTokens used for page navigation should be updated. |
Fields | |
---|---|
prev_page_token | string |
New token to retrieve previous page of results. | |
next_page_token | string |
New token to retrieve next page of results. |
Request message for method [CreateCondition][ntt.iam.v1alpha.CreateCondition]
Fields | |
---|---|
parent | string |
Parent reference of ntt.iam.v1alpha.Condition | |
condition | Condition |
Condition resource body |
Request message for method [UpdateCondition][ntt.iam.v1alpha.UpdateCondition]
Fields | |
---|---|
condition | Condition |
Condition resource body | |
update_mask | .google.protobuf.FieldMask |
FieldMask applied to request - change will be applied only for fields in the mask |
Request message for method [DeleteCondition][ntt.iam.v1alpha.DeleteCondition]
Fields | |
---|---|
name | string |
Reference of ntt.iam.v1alpha.Condition |
Parameter Type. Note: currently only STRING type is supported.
Values | |
---|---|
TYPE_UNSPECIFIED | |
STRING | |
INT64 | |
DOUBLE | |
BOOL | |
Actor is a party performing an action
Fields | |
---|---|
user | string |
service_account | string |
Check contains
Fields | |
---|---|
object | string |
Object resource name, e.g. projects/<project_id>/devices/<device_id> | |
permissions | repeated string |
Array of permissions to be verified |
Fields | |
---|---|
object | string |
Object resource name, e.g. projects/<project_id>/devices/<device_id> | |
granted_permissions | repeated string |
Granted Permissions | |
conditionally_granted_permissions | repeated ConditionalGrant |
ConditionBinding represents instantiantion of condi
Fields | |
---|---|
condition | string |
Reference to Condition which may also be parameterized | |
parameters | string |
Parameters in string form. Parameters must match [declarations][ntt.iam.v1alpha.Condition.parameter_declarations] |
ConditionChange is used by Watch notifications Responses to describe change of single Condition One of Added, Modified, Removed
Fields | |
---|---|
added | ConditionChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | ConditionChange.Modified |
Modified is returned when watched document is modified | |
removed | ConditionChange.Removed |
Removed is returned when Condition is deleted or leaves Query view |
Condition has been added to query view
Fields | |
---|---|
condition | Condition |
view_index | int32 |
Integer describing index of added Condition in resulting query view. |
Condition changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Condition | |
condition | Condition |
New version of Condition or masked difference, depending on mask_changes instrumentation of issued [WatchConditionRequest] or [WatchConditionsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Condition. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Condition new index in resulting query view. |
Removed is returned when Condition is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Condition index. |
ConditionalGrant represents grant on repeated list of permissions if any of conditions is met.
Fields | |
---|---|
permissions | repeated string |
condition_bindings | repeated ConditionBinding |
GroupChange is used by Watch notifications Responses to describe change of single Group One of Added, Modified, Removed
Fields | |
---|---|
added | GroupChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | GroupChange.Modified |
Modified is returned when watched document is modified | |
removed | GroupChange.Removed |
Removed is returned when Group is deleted or leaves Query view |
Group has been added to query view
Fields | |
---|---|
group | Group |
view_index | int32 |
Integer describing index of added Group in resulting query view. |
Group changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Group | |
group | Group |
New version of Group or masked difference, depending on mask_changes instrumentation of issued [WatchGroupRequest] or [WatchGroupsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Group. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Group new index in resulting query view. |
Removed is returned when Group is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Group index. |
GroupMemberChange is used by Watch notifications Responses to describe change of single GroupMember One of Added, Modified, Removed
Fields | |
---|---|
added | GroupMemberChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | GroupMemberChange.Modified |
Modified is returned when watched document is modified | |
removed | GroupMemberChange.Removed |
Removed is returned when GroupMember is deleted or leaves Query view |
GroupMember has been added to query view
Fields | |
---|---|
group_member | GroupMember |
view_index | int32 |
Integer describing index of added GroupMember in resulting query view. |
GroupMember changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified GroupMember | |
group_member | GroupMember |
New version of GroupMember or masked difference, depending on mask_changes instrumentation of issued [WatchGroupMemberRequest] or [WatchGroupMembersRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified GroupMember. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying GroupMember new index in resulting query view. |
Removed is returned when GroupMember is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed GroupMember index. |
Common invitation body. It's used in Project/Organization Invitations
Fields | |
---|---|
invitee_email | string |
Invitee Email address | |
inviter_actor | Actor |
Inviter User | |
inviter_full_name | string |
Denormalized data - TODO: remove it | |
inviter_email | string |
Inviter Email | |
roles | repeated string |
List of Roles to be granted on project when invitation is accepted | |
expiration_date | .google.protobuf.Timestamp |
Expiration date | |
state | Invitation.State |
Status of Invitation |
OrganizationChange is used by Watch notifications Responses to describe change of single Organization One of Added, Modified, Removed
Fields | |
---|---|
added | OrganizationChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | OrganizationChange.Modified |
Modified is returned when watched document is modified | |
removed | OrganizationChange.Removed |
Removed is returned when Organization is deleted or leaves Query view |
Organization has been added to query view
Fields | |
---|---|
organization | Organization |
view_index | int32 |
Integer describing index of added Organization in resulting query view. |
Organization changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Organization | |
organization | Organization |
New version of Organization or masked difference, depending on mask_changes instrumentation of issued [WatchOrganizationRequest] or [WatchOrganizationsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Organization. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Organization new index in resulting query view. |
Removed is returned when Organization is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Organization index. |
OrganizationInvitationChange is used by Watch notifications Responses to describe change of single OrganizationInvitation One of Added, Modified, Removed
Fields | |
---|---|
added | OrganizationInvitationChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | OrganizationInvitationChange.Modified |
Modified is returned when watched document is modified | |
removed | OrganizationInvitationChange.Removed |
Removed is returned when OrganizationInvitation is deleted or leaves Query view |
OrganizationInvitation has been added to query view
Fields | |
---|---|
organization_invitation | OrganizationInvitation |
view_index | int32 |
Integer describing index of added OrganizationInvitation in resulting query view. |
OrganizationInvitation changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified OrganizationInvitation | |
organization_invitation | OrganizationInvitation |
New version of OrganizationInvitation or masked difference, depending on mask_changes instrumentation of issued [WatchOrganizationInvitationRequest] or [WatchOrganizationInvitationsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified OrganizationInvitation. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying OrganizationInvitation new index in resulting query view. |
Removed is returned when OrganizationInvitation is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed OrganizationInvitation index. |
PermissionChange is used by Watch notifications Responses to describe change of single Permission One of Added, Modified, Removed
Fields | |
---|---|
added | PermissionChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | PermissionChange.Modified |
Modified is returned when watched document is modified | |
removed | PermissionChange.Removed |
Removed is returned when Permission is deleted or leaves Query view |
Permission has been added to query view
Fields | |
---|---|
permission | Permission |
view_index | int32 |
Integer describing index of added Permission in resulting query view. |
Permission changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Permission | |
permission | Permission |
New version of Permission or masked difference, depending on mask_changes instrumentation of issued [WatchPermissionRequest] or [WatchPermissionsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Permission. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Permission new index in resulting query view. |
Removed is returned when Permission is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Permission index. |
ProjectChange is used by Watch notifications Responses to describe change of single Project One of Added, Modified, Removed
Fields | |
---|---|
added | ProjectChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | ProjectChange.Modified |
Modified is returned when watched document is modified | |
removed | ProjectChange.Removed |
Removed is returned when Project is deleted or leaves Query view |
Project has been added to query view
Fields | |
---|---|
project | Project |
view_index | int32 |
Integer describing index of added Project in resulting query view. |
Project changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Project | |
project | Project |
New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Project. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Project new index in resulting query view. |
Removed is returned when Project is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Project index. |
ProjectInvitationChange is used by Watch notifications Responses to describe change of single ProjectInvitation One of Added, Modified, Removed
Fields | |
---|---|
added | ProjectInvitationChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | ProjectInvitationChange.Modified |
Modified is returned when watched document is modified | |
removed | ProjectInvitationChange.Removed |
Removed is returned when ProjectInvitation is deleted or leaves Query view |
ProjectInvitation has been added to query view
Fields | |
---|---|
project_invitation | ProjectInvitation |
view_index | int32 |
Integer describing index of added ProjectInvitation in resulting query view. |
ProjectInvitation changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified ProjectInvitation | |
project_invitation | ProjectInvitation |
New version of ProjectInvitation or masked difference, depending on mask_changes instrumentation of issued [WatchProjectInvitationRequest] or [WatchProjectInvitationsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified ProjectInvitation. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying ProjectInvitation new index in resulting query view. |
Removed is returned when ProjectInvitation is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed ProjectInvitation index. |
RoleBindingChange is used by Watch notifications Responses to describe change of single RoleBinding One of Added, Modified, Removed
Fields | |
---|---|
added | RoleBindingChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | RoleBindingChange.Modified |
Modified is returned when watched document is modified | |
removed | RoleBindingChange.Removed |
Removed is returned when RoleBinding is deleted or leaves Query view |
RoleBinding has been added to query view
Fields | |
---|---|
role_binding | RoleBinding |
view_index | int32 |
Integer describing index of added RoleBinding in resulting query view. |
RoleBinding changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified RoleBinding | |
role_binding | RoleBinding |
New version of RoleBinding or masked difference, depending on mask_changes instrumentation of issued [WatchRoleBindingRequest] or [WatchRoleBindingsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified RoleBinding. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying RoleBinding new index in resulting query view. |
Removed is returned when RoleBinding is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed RoleBinding index. |
RoleChange is used by Watch notifications Responses to describe change of single Role One of Added, Modified, Removed
Fields | |
---|---|
added | RoleChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | RoleChange.Modified |
Modified is returned when watched document is modified | |
removed | RoleChange.Removed |
Removed is returned when Role is deleted or leaves Query view |
Role has been added to query view
Fields | |
---|---|
role | Role |
view_index | int32 |
Integer describing index of added Role in resulting query view. |
Role changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified Role | |
role | Role |
New version of Role or masked difference, depending on mask_changes instrumentation of issued [WatchRoleRequest] or [WatchRolesRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified Role. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying Role new index in resulting query view. |
Removed is returned when Role is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed Role index. |
ServiceAccountChange is used by Watch notifications Responses to describe change of single ServiceAccount One of Added, Modified, Removed
Fields | |
---|---|
added | ServiceAccountChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | ServiceAccountChange.Modified |
Modified is returned when watched document is modified | |
removed | ServiceAccountChange.Removed |
Removed is returned when ServiceAccount is deleted or leaves Query view |
ServiceAccount has been added to query view
Fields | |
---|---|
service_account | ServiceAccount |
view_index | int32 |
Integer describing index of added ServiceAccount in resulting query view. |
ServiceAccount changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified ServiceAccount | |
service_account | ServiceAccount |
New version of ServiceAccount or masked difference, depending on mask_changes instrumentation of issued [WatchServiceAccountRequest] or [WatchServiceAccountsRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified ServiceAccount. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying ServiceAccount new index in resulting query view. |
Removed is returned when ServiceAccount is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed ServiceAccount index. |
ServiceAccountKeyChange is used by Watch notifications Responses to describe change of single ServiceAccountKey One of Added, Modified, Removed
Fields | |
---|---|
added | ServiceAccountKeyChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | ServiceAccountKeyChange.Modified |
Modified is returned when watched document is modified | |
removed | ServiceAccountKeyChange.Removed |
Removed is returned when ServiceAccountKey is deleted or leaves Query view |
ServiceAccountKey has been added to query view
Fields | |
---|---|
service_account_key | ServiceAccountKey |
view_index | int32 |
Integer describing index of added ServiceAccountKey in resulting query view. |
ServiceAccountKey changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified ServiceAccountKey | |
service_account_key | ServiceAccountKey |
New version of ServiceAccountKey or masked difference, depending on mask_changes instrumentation of issued [WatchServiceAccountKeyRequest] or [WatchServiceAccountKeysRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified ServiceAccountKey. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying ServiceAccountKey new index in resulting query view. |
Removed is returned when ServiceAccountKey is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed ServiceAccountKey index. |
UserChange is used by Watch notifications Responses to describe change of single User One of Added, Modified, Removed
Fields | |
---|---|
added | UserChange.Added |
Added is returned when watched document is added, either created or enters Query view | |
modified | UserChange.Modified |
Modified is returned when watched document is modified | |
removed | UserChange.Removed |
Removed is returned when User is deleted or leaves Query view |
User has been added to query view
Fields | |
---|---|
user | User |
view_index | int32 |
Integer describing index of added User in resulting query view. |
User changed some of it's fields - contains either full document or masked change
Fields | |
---|---|
name | string |
Name of modified User | |
user | User |
New version of User or masked difference, depending on mask_changes instrumentation of issued [WatchUserRequest] or [WatchUsersRequest] | |
field_mask | .google.protobuf.FieldMask |
Used when mask_changes is set, contains field paths of modified properties. | |
previous_view_index | int32 |
Previous view index specifies previous position of modified User. When modification doesn't affect sorted order, value will remain identical to [view_index]. | |
view_index | int32 |
Integer specifying User new index in resulting query view. |
Removed is returned when User is deleted or leaves Query view
Fields | |
---|---|
name | string |
view_index | int32 |
Integer specifying removed User index. |
Invitation FSM States
Values | |
---|---|
STATE_UNSPECIFIED | |
PENDING | |
ACCEPTED | |
DECLINED | |
EXPIRED | |