|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437 |
- {
- "auth": {
- "oauth2": {
- "scopes": {
- "https://www.googleapis.com/auth/cloud-platform": {
- "description": "View and manage your data across Google Cloud Platform services"
- },
- "https://www.googleapis.com/auth/compute": {
- "description": "View and manage your Google Compute Engine resources"
- }
- }
- }
- },
- "basePath": "",
- "baseUrl": "https://oslogin.googleapis.com/",
- "batchPath": "batch",
- "canonicalName": "Cloud OS Login",
- "description": "Manages OS login configuration for Google account users.",
- "discoveryVersion": "v1",
- "documentationLink": "https://cloud.google.com/compute/docs/oslogin/",
- "fullyEncodeReservedExpansion": true,
- "icons": {
- "x16": "http://www.google.com/images/icons/product/search-16.gif",
- "x32": "http://www.google.com/images/icons/product/search-32.gif"
- },
- "id": "oslogin:v1",
- "kind": "discovery#restDescription",
- "name": "oslogin",
- "ownerDomain": "google.com",
- "ownerName": "Google",
- "parameters": {
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "access_token": {
- "description": "OAuth access token.",
- "location": "query",
- "type": "string"
- },
- "alt": {
- "default": "json",
- "description": "Data format for response.",
- "enum": [
- "json",
- "media",
- "proto"
- ],
- "enumDescriptions": [
- "Responses with Content-Type of application/json",
- "Media download with context-dependent Content-Type",
- "Responses with Content-Type of application/x-protobuf"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "key": {
- "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.",
- "location": "query",
- "type": "string"
- },
- "oauth_token": {
- "description": "OAuth 2.0 token for the current user.",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "quotaUser": {
- "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.",
- "location": "query",
- "type": "string"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
- }
- },
- "protocol": "rest",
- "resources": {
- "users": {
- "methods": {
- "getLoginProfile": {
- "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.",
- "flatPath": "v1/users/{usersId}/loginProfile",
- "httpMethod": "GET",
- "id": "oslogin.users.getLoginProfile",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "location": "path",
- "pattern": "^users/[^/]+$",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The project ID of the Google Cloud Platform project.",
- "location": "query",
- "type": "string"
- },
- "systemId": {
- "description": "A system ID for filtering the results of the request.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+name}/loginProfile",
- "response": {
- "$ref": "LoginProfile"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "importSshPublicKey": {
- "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.",
- "flatPath": "v1/users/{usersId}:importSshPublicKey",
- "httpMethod": "POST",
- "id": "oslogin.users.importSshPublicKey",
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "The unique ID for the user in format `users/{user}`.",
- "location": "path",
- "pattern": "^users/[^/]+$",
- "required": true,
- "type": "string"
- },
- "projectId": {
- "description": "The project ID of the Google Cloud Platform project.",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+parent}:importSshPublicKey",
- "request": {
- "$ref": "SshPublicKey"
- },
- "response": {
- "$ref": "ImportSshPublicKeyResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- },
- "resources": {
- "projects": {
- "methods": {
- "delete": {
- "description": "Deletes a POSIX account.",
- "flatPath": "v1/users/{usersId}/projects/{projectsId}",
- "httpMethod": "DELETE",
- "id": "oslogin.users.projects.delete",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.",
- "location": "path",
- "pattern": "^users/[^/]+/projects/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- },
- "sshPublicKeys": {
- "methods": {
- "delete": {
- "description": "Deletes an SSH public key.",
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "httpMethod": "DELETE",
- "id": "oslogin.users.sshPublicKeys.delete",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "location": "path",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "get": {
- "description": "Retrieves an SSH public key.",
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "httpMethod": "GET",
- "id": "oslogin.users.sshPublicKeys.get",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.",
- "location": "path",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "response": {
- "$ref": "SshPublicKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- },
- "patch": {
- "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.",
- "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}",
- "httpMethod": "PATCH",
- "id": "oslogin.users.sshPublicKeys.patch",
- "parameterOrder": [
- "name"
- ],
- "parameters": {
- "name": {
- "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.",
- "location": "path",
- "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$",
- "required": true,
- "type": "string"
- },
- "updateMask": {
- "description": "Mask to control which fields get updated. Updates all if not present.",
- "format": "google-fieldmask",
- "location": "query",
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "request": {
- "$ref": "SshPublicKey"
- },
- "response": {
- "$ref": "SshPublicKey"
- },
- "scopes": [
- "https://www.googleapis.com/auth/cloud-platform",
- "https://www.googleapis.com/auth/compute"
- ]
- }
- }
- }
- }
- }
- },
- "revision": "20190107",
- "rootUrl": "https://oslogin.googleapis.com/",
- "schemas": {
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "id": "Empty",
- "properties": {},
- "type": "object"
- },
- "ImportSshPublicKeyResponse": {
- "description": "A response message for importing an SSH public key.",
- "id": "ImportSshPublicKeyResponse",
- "properties": {
- "loginProfile": {
- "$ref": "LoginProfile",
- "description": "The login profile information for the user."
- }
- },
- "type": "object"
- },
- "LoginProfile": {
- "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.",
- "id": "LoginProfile",
- "properties": {
- "name": {
- "description": "A unique user ID.",
- "type": "string"
- },
- "posixAccounts": {
- "description": "The list of POSIX accounts associated with the user.",
- "items": {
- "$ref": "PosixAccount"
- },
- "type": "array"
- },
- "sshPublicKeys": {
- "additionalProperties": {
- "$ref": "SshPublicKey"
- },
- "description": "A map from SSH public key fingerprint to the associated key object.",
- "type": "object"
- }
- },
- "type": "object"
- },
- "PosixAccount": {
- "description": "The POSIX account information associated with a Google account.",
- "id": "PosixAccount",
- "properties": {
- "accountId": {
- "description": "Output only. A POSIX account identifier.",
- "type": "string"
- },
- "gecos": {
- "description": "The GECOS (user information) entry for this account.",
- "type": "string"
- },
- "gid": {
- "description": "The default group ID.",
- "format": "int64",
- "type": "string"
- },
- "homeDirectory": {
- "description": "The path to the home directory for this account.",
- "type": "string"
- },
- "operatingSystemType": {
- "description": "The operating system type where this account applies.",
- "enum": [
- "OPERATING_SYSTEM_TYPE_UNSPECIFIED",
- "LINUX",
- "WINDOWS"
- ],
- "enumDescriptions": [
- "The operating system type associated with the user account information is\nunspecified.",
- "Linux user account information.",
- "Windows user account information."
- ],
- "type": "string"
- },
- "primary": {
- "description": "Only one POSIX account can be marked as primary.",
- "type": "boolean"
- },
- "shell": {
- "description": "The path to the logic shell for this account.",
- "type": "string"
- },
- "systemId": {
- "description": "System identifier for which account the username or uid applies to.\nBy default, the empty value is used.",
- "type": "string"
- },
- "uid": {
- "description": "The user ID.",
- "format": "int64",
- "type": "string"
- },
- "username": {
- "description": "The username of the POSIX account.",
- "type": "string"
- }
- },
- "type": "object"
- },
- "SshPublicKey": {
- "description": "The SSH public key information associated with a Google account.",
- "id": "SshPublicKey",
- "properties": {
- "expirationTimeUsec": {
- "description": "An expiration time in microseconds since epoch.",
- "format": "int64",
- "type": "string"
- },
- "fingerprint": {
- "description": "Output only. The SHA-256 fingerprint of the SSH public key.",
- "type": "string"
- },
- "key": {
- "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.",
- "type": "string"
- }
- },
- "type": "object"
- }
- },
- "servicePath": "",
- "title": "Cloud OS Login API",
- "version": "v1",
- "version_module": true
- }
|