Skip to content

Search is only available in production builds. Try building and previewing the site to test it out locally.

IamService

platform.v1.IamService

  • Request: ListOrganizationsRequest
  • Response: ListOrganizationsResponse
  • REST mapping: GET /v1/organizations
  • Request: ListAppsRequest
  • Response: ListAppsResponse
  • REST mapping: GET /v1/apps
  • Request: GetAppRequest
  • Response: App
  • REST mapping: GET /v1/apps/{id}
  • Request: CreateAppRequest
  • Response: CreateAppResponse
  • REST mapping: POST /v1/apps
  • Request: UpdateAppRequest
  • Response: App
  • REST mapping: PATCH /v1/apps/{id}

DeleteApp is refused while the app holds resources or other apps.

  • Request: DeleteAppRequest
  • Response: DeleteAppResponse
  • REST mapping: DELETE /v1/apps/{id}
  • Request: MoveResourcesRequest
  • Response: MoveResourcesResponse
  • REST mapping: POST /v1/apps/{app_id}:moveResources
  • Request: ListRolesRequest
  • Response: ListRolesResponse
  • REST mapping: GET /v1/roles
  • Request: ListMembersRequest
  • Response: ListMembersResponse
  • REST mapping: GET /v1/members
  • Request: CheckPermissionRequest
  • Response: CheckPermissionResponse
  • REST mapping: POST /v1/iam:checkPermission

App groups a tenant’s resources. Apps nest; a view of an app includes the apps below it, and a role held on an app applies to them as well.

FieldType#Notes
idstring1app_… (proj_… for apps created as projects)
orgstring2
namestring3
parent_idstring4empty for a top-level app
descriptionstring5
template_idstring6the template the app was created from, if any

CheckPermission powers the “test this permission” simulator in the IAM UI.

FieldType#Notes
principalstring1
permissionstring2
scopestring3
FieldType#Notes
allowedbool1
reasonstring2
FieldType#Notes
orgstring1the tenant; defaults to the caller’s
namestring2
parent_idstring3empty for a top-level app
descriptionstring4
attach_idsstring5existing resources to move into the new app
template_idstring6launch the template’s items into the app
FieldType#Notes
appApp1
operationsOperation2One operation per template item. A failed item leaves the others running.
FieldType#Notes
idstring1

No fields.

FieldType#Notes
idstring1
FieldType#Notes
orgstring1
FieldType#Notes
appsApp1
FieldType#Notes
scopestring1
FieldType#Notes
membersMember1

No fields.

FieldType#Notes
organizationsOrganization1

No fields.

FieldType#Notes
rolesRole1
FieldType#Notes
app_idstring1the destination
resource_idsstring2
FieldType#Notes
movedstring1
FieldType#Notes
idstring1
namestring2
descriptionstring3
parent_idstring4"" moves the app to the top level