Skip to content

Instantly share code, notes, and snippets.

@bcoe

bcoe/staging-iot.json

Created September 28, 2023 12:41
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save bcoe/4fb7de8ae1c36b01e0d21e3a0bb121f3 to your computer and use it in GitHub Desktop.
Save bcoe/4fb7de8ae1c36b01e0d21e3a0bb121f3 to your computer and use it in GitHub Desktop.
Download ZIP
staging-iot.json
Raw
staging-iot.json
{
"kind": "discovery#restDescription",
"discoveryVersion": "v1",
"resources": {
"projects": {
"resources": {
"locations": {
"resources": {
"registries": {
"resources": {
"groups": {
"methods": {
"setIamPolicy": {
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"httpMethod": "POST",
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"type": "string",
"required": true
}
},
"parameterOrder": [
"resource"
],
"id": "cloudiot.projects.locations.registries.groups.setIamPolicy",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"path": "v1/{+resource}:setIamPolicy",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:setIamPolicy",
"description": "Sets the access control policy on the specified resource. Replaces any existing policy."
},
"testIamPermissions": {
"id": "cloudiot.projects.locations.registries.groups.testIamPermissions",
"path": "v1/{+resource}:testIamPermissions",
"parameterOrder": [
"resource"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:testIamPermissions",
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$",
"location": "path",
"required": true,
"type": "string"
}
},
"request": {
"$ref": "TestIamPermissionsRequest"
},
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.",
"response": {
"$ref": "TestIamPermissionsResponse"
}
},
"getIamPolicy": {
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"response": {
"$ref": "Policy"
},
"request": {
"$ref": "GetIamPolicyRequest"
},
"id": "cloudiot.projects.locations.registries.groups.getIamPolicy",
"parameterOrder": [
"resource"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/groups/{groupsId}:getIamPolicy",
"path": "v1/{+resource}:getIamPolicy",
"parameters": {
"resource": {
"required": true,
"location": "path",
"type": "string",
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/groups/[^/]+$"
}
}
}
}
}
},
"methods": {
"setIamPolicy": {
"httpMethod": "POST",
"response": {
"$ref": "Policy"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"parameters": {
"resource": {
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"type": "string"
}
},
"description": "Sets the access control policy on the specified resource. Replaces any existing policy.",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"id": "cloudiot.projects.locations.registries.setIamPolicy",
"path": "v1/{+resource}:setIamPolicy",
"parameterOrder": [
"resource"
]
},
"getIamPolicy": {
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"parameterOrder": [
"resource"
],
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"id": "cloudiot.projects.locations.registries.getIamPolicy",
"request": {
"$ref": "GetIamPolicyRequest"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"path": "v1/{+resource}:getIamPolicy",
"httpMethod": "POST",
"parameters": {
"resource": {
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"type": "string",
"location": "path",
"required": true,
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field."
}
}
},
"testIamPermissions": {
"response": {
"$ref": "TestIamPermissionsResponse"
},
"httpMethod": "POST",
"id": "cloudiot.projects.locations.registries.testIamPermissions",
"scopes": [
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloudiot"
],
"request": {
"$ref": "TestIamPermissionsRequest"
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions",
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.",
"path": "v1/{+resource}:testIamPermissions",
"parameters": {
"resource": {
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$",
"required": true,
"type": "string",
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field."
}
},
"parameterOrder": [
"resource"
]
}
}
}
}
}
}
}
},
"fullyEncodeReservedExpansion": true,
"mtlsRootUrl": "https://staging-cloudiot.mtls.sandbox.googleapis.com/",
"title": "Cloud IoT API (Staging)",
"version_module": true,
"parameters": {
"access_token": {
"type": "string",
"description": "OAuth access token.",
"location": "query"
},
"prettyPrint": {
"type": "boolean",
"default": "true",
"location": "query",
"description": "Returns response with indentations and line breaks."
},
"$.xgafv": {
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"description": "V1 error format.",
"type": "string",
"location": "query"
},
"alt": {
"location": "query",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"type": "string"
},
"callback": {
"location": "query",
"description": "JSONP",
"type": "string"
},
"upload_protocol": {
"location": "query",
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string"
},
"fields": {
"location": "query",
"type": "string",
"description": "Selector specifying which fields to include in a partial response."
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"uploadType": {
"location": "query",
"type": "string",
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")."
},
"key": {
"location": "query",
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"type": "string"
},
"quotaUser": {
"type": "string",
"location": "query",
"description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters."
}
},
"basePath": "",
"ownerDomain": "google.com",
"protocol": "rest",
"id": "cloudiot:v1",
"batchPath": "batch",
"description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform. ",
"baseUrl": "https://staging-cloudiot.sandbox.googleapis.com/",
"icons": {
"x32": "http://www.google.com/images/icons/product/search-32.gif",
"x16": "http://www.google.com/images/icons/product/search-16.gif"
},
"revision": "20230927",
"documentationLink": "https://cloud.google.com/iot",
"servicePath": "",
"canonicalName": "Cloud Iot",
"rootUrl": "https://staging-cloudiot.sandbox.googleapis.com/",
"ownerName": "Google",
"schemas": {
"GetPolicyOptions": {
"description": "Encapsulates settings provided to GetIamPolicy.",
"id": "GetPolicyOptions",
"type": "object",
"properties": {
"requestedPolicyVersion": {
"type": "integer",
"format": "int32",
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
}
}
},
"GetIamPolicyRequest": {
"properties": {
"options": {
"$ref": "GetPolicyOptions",
"description": "OPTIONAL: A `GetPolicyOptions` object for specifying options to `GetIamPolicy`."
}
},
"id": "GetIamPolicyRequest",
"description": "Request message for `GetIamPolicy` method.",
"type": "object"
},
"Expr": {
"description": "Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: \"Summary size limit\" description: \"Determines if a summary is less than 100 chars\" expression: \"document.summary.size() \u003c 100\" Example (Equality): title: \"Requestor is owner\" description: \"Determines if requestor is the document owner\" expression: \"document.owner == request.auth.claims.email\" Example (Logic): title: \"Public documents\" description: \"Determine whether the document should be publicly visible\" expression: \"document.type != 'private' && document.type != 'internal'\" Example (Data Manipulation): title: \"Notification string\" description: \"Create a notification string with a timestamp.\" expression: \"'New message received at ' + string(document.create_time)\" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.",
"type": "object",
"properties": {
"location": {
"type": "string",
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file."
},
"title": {
"type": "string",
"description": "Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression."
},
"description": {
"type": "string",
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI."
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
}
},
"id": "Expr"
},
"TestIamPermissionsResponse": {
"properties": {
"permissions": {
"type": "array",
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
}
}
},
"id": "TestIamPermissionsResponse",
"description": "Response message for `TestIamPermissions` method.",
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"properties": {
"permissions": {
"description": "The set of permissions to check for the `resource`. Permissions with wildcards (such as `*` or `storage.*`) are not allowed. For more information see [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).",
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object",
"id": "TestIamPermissionsRequest"
},
"Binding": {
"type": "object",
"id": "Binding",
"properties": {
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.",
"type": "string"
},
"members": {
"type": "array",
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding. * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding. * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.",
"items": {
"type": "string"
}
},
"condition": {
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"$ref": "Expr"
}
},
"description": "Associates `members`, or principals, with a `role`."
},
"Policy": {
"description": "An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A `Policy` is a collection of `bindings`. A `binding` binds one or more `members`, or principals, to a single `role`. Principals can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies). **JSON example:** ``` { \"bindings\": [ { \"role\": \"roles/resourcemanager.organizationAdmin\", \"members\": [ \"user:mike@example.com\", \"group:admins@example.com\", \"domain:google.com\", \"serviceAccount:my-project-id@appspot.gserviceaccount.com\" ] }, { \"role\": \"roles/resourcemanager.organizationViewer\", \"members\": [ \"user:eve@example.com\" ], \"condition\": { \"title\": \"expirable access\", \"description\": \"Does not grant access after Sep 2020\", \"expression\": \"request.time \u003c timestamp('2020-10-01T00:00:00.000Z')\", } } ], \"etag\": \"BwWWja0YfJA=\", \"version\": 3 } ``` **YAML example:** ``` bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time \u003c timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 ``` For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"bindings": {
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"type": "array",
"items": {
"$ref": "Binding"
}
},
"version": {
"format": "int32",
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"type": "integer"
},
"etag": {
"format": "byte",
"description": "`etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"type": "string"
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"id": "SetIamPolicyRequest",
"type": "object",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
}
},
"description": "Request message for `SetIamPolicy` method."
}
},
"version": "v1",
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloudiot": {
"description": "Register and manage devices in the Google Cloud IoT service"
},
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"name": "cloudiot"
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment