Skip to content

Commit e82e5c6

Browse files
feat(oslogin): update the API
#### oslogin:v1alpha The following keys were added: - resources.projects.resources.locations.methods.signSshPublicKey.description - resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.projects.resources.locations.methods.signSshPublicKey.id - resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.projects.resources.locations.methods.signSshPublicKey.path - resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.projects.resources.locations.methods.signSshPublicKey.scopes - resources.users.resources.projects.methods.provisionPosixAccount.description - resources.users.resources.projects.methods.provisionPosixAccount.flatPath - resources.users.resources.projects.methods.provisionPosixAccount.httpMethod - resources.users.resources.projects.methods.provisionPosixAccount.id - resources.users.resources.projects.methods.provisionPosixAccount.parameterOrder - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.description - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.location - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.pattern - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.required - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.type - resources.users.resources.projects.methods.provisionPosixAccount.path - resources.users.resources.projects.methods.provisionPosixAccount.request.$ref - resources.users.resources.projects.methods.provisionPosixAccount.response.$ref - resources.users.resources.projects.methods.provisionPosixAccount.scopes - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.id - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.appEngineInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.appEngineInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.computeInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.computeInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.serviceAccount.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.serviceAccount.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.sshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.properties.sshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.id - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.properties.signedSshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.properties.signedSshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse.type - schemas.ProvisionPosixAccountRequest.description - schemas.ProvisionPosixAccountRequest.id - schemas.ProvisionPosixAccountRequest.properties.regions.description - schemas.ProvisionPosixAccountRequest.properties.regions.items.type - schemas.ProvisionPosixAccountRequest.properties.regions.type - schemas.ProvisionPosixAccountRequest.type #### oslogin:v1beta The following keys were added: - resources.projects.resources.locations.methods.signSshPublicKey.description - resources.projects.resources.locations.methods.signSshPublicKey.flatPath - resources.projects.resources.locations.methods.signSshPublicKey.httpMethod - resources.projects.resources.locations.methods.signSshPublicKey.id - resources.projects.resources.locations.methods.signSshPublicKey.parameterOrder - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.description - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.location - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.pattern - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.required - resources.projects.resources.locations.methods.signSshPublicKey.parameters.parent.type - resources.projects.resources.locations.methods.signSshPublicKey.path - resources.projects.resources.locations.methods.signSshPublicKey.request.$ref - resources.projects.resources.locations.methods.signSshPublicKey.response.$ref - resources.projects.resources.locations.methods.signSshPublicKey.scopes - resources.users.resources.projects.methods.provisionPosixAccount.description - resources.users.resources.projects.methods.provisionPosixAccount.flatPath - resources.users.resources.projects.methods.provisionPosixAccount.httpMethod - resources.users.resources.projects.methods.provisionPosixAccount.id - resources.users.resources.projects.methods.provisionPosixAccount.parameterOrder - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.description - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.location - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.pattern - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.required - resources.users.resources.projects.methods.provisionPosixAccount.parameters.name.type - resources.users.resources.projects.methods.provisionPosixAccount.path - resources.users.resources.projects.methods.provisionPosixAccount.request.$ref - resources.users.resources.projects.methods.provisionPosixAccount.response.$ref - resources.users.resources.projects.methods.provisionPosixAccount.scopes - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.id - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.appEngineInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.appEngineInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.computeInstance.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.computeInstance.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.serviceAccount.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.serviceAccount.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.sshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.properties.sshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.id - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.properties.signedSshPublicKey.description - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.properties.signedSshPublicKey.type - schemas.GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse.type - schemas.ProvisionPosixAccountRequest.description - schemas.ProvisionPosixAccountRequest.id - schemas.ProvisionPosixAccountRequest.properties.regions.description - schemas.ProvisionPosixAccountRequest.properties.regions.items.type - schemas.ProvisionPosixAccountRequest.properties.regions.type - schemas.ProvisionPosixAccountRequest.type
1 parent cd205d9 commit e82e5c6

File tree

4 files changed

+760
-2
lines changed

4 files changed

+760
-2
lines changed

discovery/oslogin-v1alpha.json

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,42 @@
114114
},
115115
"protocol": "rest",
116116
"resources": {
117+
"projects": {
118+
"resources": {
119+
"locations": {
120+
"methods": {
121+
"signSshPublicKey": {
122+
"description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.",
123+
"flatPath": "v1alpha/projects/{projectsId}/locations/{locationsId}:signSshPublicKey",
124+
"httpMethod": "POST",
125+
"id": "oslogin.projects.locations.signSshPublicKey",
126+
"parameterOrder": [
127+
"parent"
128+
],
129+
"parameters": {
130+
"parent": {
131+
"description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}",
132+
"location": "path",
133+
"pattern": "^projects/[^/]+/locations/[^/]+$",
134+
"required": true,
135+
"type": "string"
136+
}
137+
},
138+
"path": "v1alpha/{+parent}:signSshPublicKey",
139+
"request": {
140+
"$ref": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest"
141+
},
142+
"response": {
143+
"$ref": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse"
144+
},
145+
"scopes": [
146+
"https://www.googleapis.com/auth/cloud-platform"
147+
]
148+
}
149+
}
150+
}
151+
}
152+
},
117153
"users": {
118154
"methods": {
119155
"getLoginProfile": {
@@ -283,6 +319,35 @@
283319
"https://www.googleapis.com/auth/cloud-platform",
284320
"https://www.googleapis.com/auth/compute"
285321
]
322+
},
323+
"provisionPosixAccount": {
324+
"description": "Create a POSIX account if it doesn't exist.",
325+
"flatPath": "v1alpha/users/{usersId}/projects/{projectsId}",
326+
"httpMethod": "POST",
327+
"id": "oslogin.users.projects.provisionPosixAccount",
328+
"parameterOrder": [
329+
"name"
330+
],
331+
"parameters": {
332+
"name": {
333+
"description": "Required. The unique ID for the user in format `users/{user}/projects/{project}`.",
334+
"location": "path",
335+
"pattern": "^users/[^/]+/projects/[^/]+$",
336+
"required": true,
337+
"type": "string"
338+
}
339+
},
340+
"path": "v1alpha/{+name}",
341+
"request": {
342+
"$ref": "ProvisionPosixAccountRequest"
343+
},
344+
"response": {
345+
"$ref": "PosixAccount"
346+
},
347+
"scopes": [
348+
"https://www.googleapis.com/auth/cloud-platform",
349+
"https://www.googleapis.com/auth/compute"
350+
]
286351
}
287352
},
288353
"resources": {
@@ -477,7 +542,7 @@
477542
}
478543
}
479544
},
480-
"revision": "20241208",
545+
"revision": "20250302",
481546
"rootUrl": "https://oslogin.googleapis.com/",
482547
"schemas": {
483548
"Empty": {
@@ -486,6 +551,40 @@
486551
"properties": {},
487552
"type": "object"
488553
},
554+
"GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest": {
555+
"description": "A request message for signing an SSH public key.",
556+
"id": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyRequest",
557+
"properties": {
558+
"appEngineInstance": {
559+
"description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}",
560+
"type": "string"
561+
},
562+
"computeInstance": {
563+
"description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}",
564+
"type": "string"
565+
},
566+
"serviceAccount": {
567+
"description": "Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the",
568+
"type": "string"
569+
},
570+
"sshPublicKey": {
571+
"description": "Required. The SSH public key to sign.",
572+
"type": "string"
573+
}
574+
},
575+
"type": "object"
576+
},
577+
"GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse": {
578+
"description": "The response message for signing an SSH public key.",
579+
"id": "GoogleCloudOsloginControlplaneRegionalV1alphaSignSshPublicKeyResponse",
580+
"properties": {
581+
"signedSshPublicKey": {
582+
"description": "The signed SSH public key to use in the SSH handshake.",
583+
"type": "string"
584+
}
585+
},
586+
"type": "object"
587+
},
489588
"ImportSshPublicKeyResponse": {
490589
"description": "A response message for importing an SSH public key.",
491590
"id": "ImportSshPublicKeyResponse",
@@ -598,6 +697,20 @@
598697
},
599698
"type": "object"
600699
},
700+
"ProvisionPosixAccountRequest": {
701+
"description": "A request message for creating a POSIX account entry.",
702+
"id": "ProvisionPosixAccountRequest",
703+
"properties": {
704+
"regions": {
705+
"description": "Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.",
706+
"items": {
707+
"type": "string"
708+
},
709+
"type": "array"
710+
}
711+
},
712+
"type": "object"
713+
},
601714
"SecurityKey": {
602715
"description": "The credential information for a Google registered security key.",
603716
"id": "SecurityKey",

discovery/oslogin-v1beta.json

Lines changed: 114 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,42 @@
114114
},
115115
"protocol": "rest",
116116
"resources": {
117+
"projects": {
118+
"resources": {
119+
"locations": {
120+
"methods": {
121+
"signSshPublicKey": {
122+
"description": "Signs an SSH public key for a user to authenticate to a virtual machine on Google Compute Engine.",
123+
"flatPath": "v1beta/projects/{projectsId}/locations/{locationsId}:signSshPublicKey",
124+
"httpMethod": "POST",
125+
"id": "oslogin.projects.locations.signSshPublicKey",
126+
"parameterOrder": [
127+
"parent"
128+
],
129+
"parameters": {
130+
"parent": {
131+
"description": "Required. The parent for the signing request. Format: projects/{project}/locations/{location}",
132+
"location": "path",
133+
"pattern": "^projects/[^/]+/locations/[^/]+$",
134+
"required": true,
135+
"type": "string"
136+
}
137+
},
138+
"path": "v1beta/{+parent}:signSshPublicKey",
139+
"request": {
140+
"$ref": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest"
141+
},
142+
"response": {
143+
"$ref": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse"
144+
},
145+
"scopes": [
146+
"https://www.googleapis.com/auth/cloud-platform"
147+
]
148+
}
149+
}
150+
}
151+
}
152+
},
117153
"users": {
118154
"methods": {
119155
"getLoginProfile": {
@@ -253,6 +289,35 @@
253289
"https://www.googleapis.com/auth/cloud-platform",
254290
"https://www.googleapis.com/auth/compute"
255291
]
292+
},
293+
"provisionPosixAccount": {
294+
"description": "Create a POSIX account if it doesn't exist.",
295+
"flatPath": "v1beta/users/{usersId}/projects/{projectsId}",
296+
"httpMethod": "POST",
297+
"id": "oslogin.users.projects.provisionPosixAccount",
298+
"parameterOrder": [
299+
"name"
300+
],
301+
"parameters": {
302+
"name": {
303+
"description": "Required. The unique ID for the user in format `users/{user}/projects/{project}`.",
304+
"location": "path",
305+
"pattern": "^users/[^/]+/projects/[^/]+$",
306+
"required": true,
307+
"type": "string"
308+
}
309+
},
310+
"path": "v1beta/{+name}",
311+
"request": {
312+
"$ref": "ProvisionPosixAccountRequest"
313+
},
314+
"response": {
315+
"$ref": "PosixAccount"
316+
},
317+
"scopes": [
318+
"https://www.googleapis.com/auth/cloud-platform",
319+
"https://www.googleapis.com/auth/compute"
320+
]
256321
}
257322
},
258323
"resources": {
@@ -447,7 +512,7 @@
447512
}
448513
}
449514
},
450-
"revision": "20240616",
515+
"revision": "20250302",
451516
"rootUrl": "https://oslogin.googleapis.com/",
452517
"schemas": {
453518
"Empty": {
@@ -456,6 +521,40 @@
456521
"properties": {},
457522
"type": "object"
458523
},
524+
"GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest": {
525+
"description": "A request message for signing an SSH public key.",
526+
"id": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyRequest",
527+
"properties": {
528+
"appEngineInstance": {
529+
"description": "The App Engine instance to sign the SSH public key for. Expected format: services/{service}/versions/{version}/instances/{instance}",
530+
"type": "string"
531+
},
532+
"computeInstance": {
533+
"description": "The compute instance to sign the SSH public key for. Expected format: projects/{project}/zones/{zone}/instances/{numeric_instance_id}",
534+
"type": "string"
535+
},
536+
"serviceAccount": {
537+
"description": "Optional. The service account for the Compute instance. If the instance in question does not have a service account, this field should be left empty. If the wrong service account is provided, this operation will return a signed certificate that will not be accepted by the VM. During rollout of the new regionalized SignSshPublicKey API, this field will be required for all requests, but the VM will not initially carry out the",
538+
"type": "string"
539+
},
540+
"sshPublicKey": {
541+
"description": "Required. The SSH public key to sign.",
542+
"type": "string"
543+
}
544+
},
545+
"type": "object"
546+
},
547+
"GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse": {
548+
"description": "The response message for signing an SSH public key.",
549+
"id": "GoogleCloudOsloginControlplaneRegionalV1betaSignSshPublicKeyResponse",
550+
"properties": {
551+
"signedSshPublicKey": {
552+
"description": "The signed SSH public key to use in the SSH handshake.",
553+
"type": "string"
554+
}
555+
},
556+
"type": "object"
557+
},
459558
"ImportSshPublicKeyResponse": {
460559
"description": "A response message for importing an SSH public key.",
461560
"id": "ImportSshPublicKeyResponse",
@@ -568,6 +667,20 @@
568667
},
569668
"type": "object"
570669
},
670+
"ProvisionPosixAccountRequest": {
671+
"description": "A request message for creating a POSIX account entry.",
672+
"id": "ProvisionPosixAccountRequest",
673+
"properties": {
674+
"regions": {
675+
"description": "Optional. The regions to wait for a POSIX account to be written to before returning a response. If unspecified, defaults to all regions. Regions are listed at https://cloud.google.com/about/locations#region.",
676+
"items": {
677+
"type": "string"
678+
},
679+
"type": "array"
680+
}
681+
},
682+
"type": "object"
683+
},
571684
"SecurityKey": {
572685
"description": "The credential information for a Google registered security key.",
573686
"id": "SecurityKey",

0 commit comments

Comments
 (0)