Note:
This documentation is for version 3.5.0 of the library.
Some samples may not work with other versions.
Installation
Install the Google.Cloud.OsLogin.V1 package from NuGet. Add it to
your project in the normal way (for example by right-clicking on the
project in Visual Studio and choosing "Manage NuGet Packages...").
Authentication
When running on Google Cloud, no action needs to be taken to authenticate.
Otherwise, the simplest way of authenticating your API calls is to
set up Application Default Credentials.
The credentials will automatically be used to authenticate. See
Set up Application Default Credentials for more details.
Create a client instance by calling the static Create or CreateAsync methods. Alternatively,
use the builder class associated with each client class (e.g. OsLoginServiceClientBuilder for OsLoginServiceClient)
as an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,
and we recommend using a single instance across your entire application unless you have a particular need
to configure multiple client objects separately.
Using the REST (HTTP/1.1) transport
This library defaults to performing RPCs using gRPC using the binary Protocol Buffer wire format.
However, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy
or other network issue.) To create a client using HTTP/1.1, specify a RestGrpcAdapter reference for the GrpcAdapter property in the client builder.
Sample code:
var client = new OsLoginServiceClientBuilder
{
GrpcAdapter = RestGrpcAdapter.Default
}.Build();
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[[["\u003cp\u003e\u003ccode\u003eGoogle.Cloud.OsLogin.V1\u003c/code\u003e is a .NET client library for the Google Cloud OS Login API, with the current documentation focusing on version 3.5.0.\u003c/p\u003e\n"],["\u003cp\u003eThe library can be installed via NuGet, and when running on Google Cloud, authentication is automatic, otherwise, Application Default Credentials should be used.\u003c/p\u003e\n"],["\u003cp\u003eAll operations are managed through \u003ccode\u003eOsLoginServiceClient\u003c/code\u003e, which can be created using the \u003ccode\u003eCreate\u003c/code\u003e or \u003ccode\u003eCreateAsync\u003c/code\u003e methods, or by using \u003ccode\u003eOsLoginServiceClientBuilder\u003c/code\u003e for customization.\u003c/p\u003e\n"],["\u003cp\u003eBy default, the library uses gRPC with Protocol Buffer, but it can also support HTTP/1.1 and JSON by setting the \u003ccode\u003eRestGrpcAdapter\u003c/code\u003e property within the client builder.\u003c/p\u003e\n"],["\u003cp\u003eThe available versions for the library range from 3.5.0 to 2.2.0, and there is a direct link for each version.\u003c/p\u003e\n"]]],[],null,["Version latestkeyboard_arrow_down\n\n- [3.5.0 (latest)](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/latest)\n- [3.4.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/3.4.0)\n- [3.3.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/3.3.0)\n- [3.2.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/3.2.0)\n- [3.1.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/3.1.0)\n- [3.0.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/3.0.0)\n- [2.3.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/2.3.0)\n- [2.2.0](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/2.2.0) \n\nGoogle.Cloud.OsLogin.V1\n=======================\n\n`Google.Cloud.OsLogin.V1` is a.NET client library for the [Google Cloud OS Login API](https://cloud.google.com/compute/docs/instances/managing-instance-access).\n\nNote:\nThis documentation is for version `3.5.0` of the library.\nSome samples may not work with other versions.\n\nInstallation\n------------\n\nInstall the `Google.Cloud.OsLogin.V1` package from NuGet. Add it to\nyour project in the normal way (for example by right-clicking on the\nproject in Visual Studio and choosing \"Manage NuGet Packages...\").\n\nAuthentication\n--------------\n\nWhen running on Google Cloud, no action needs to be taken to authenticate.\n\nOtherwise, the simplest way of authenticating your API calls is to\nset up Application Default Credentials.\nThe credentials will automatically be used to authenticate. See\n[Set up Application Default Credentials](https://cloud.google.com/docs/authentication/provide-credentials-adc) for more details.\n\nGetting started\n---------------\n\nAll operations are performed through [OsLoginServiceClient](/dotnet/docs/reference/Google.Cloud.OsLogin.V1/latest/Google.Cloud.OsLogin.V1.OsLoginServiceClient).\n\nCreate a client instance by calling the static `Create` or `CreateAsync` methods. Alternatively,\nuse the builder class associated with each client class (e.g. OsLoginServiceClientBuilder for OsLoginServiceClient)\nas an easy way of specifying custom credentials, settings, or a custom endpoint. Clients are thread-safe,\nand we recommend using a single instance across your entire application unless you have a particular need\nto configure multiple client objects separately.\n\n### Using the REST (HTTP/1.1) transport\n\nThis library defaults to performing RPCs using [gRPC](https://grpc.io/) using the binary [Protocol Buffer](https://protobuf.dev) wire format.\nHowever, it also supports HTTP/1.1 and JSON, for situations where gRPC doesn't work as desired. (This is typically due to an incompatible proxy\nor other network issue.) To create a client using HTTP/1.1, specify a `RestGrpcAdapter` reference for the `GrpcAdapter` property in the client builder.\nSample code: \n\n var client = new OsLoginServiceClientBuilder\n {\n GrpcAdapter = RestGrpcAdapter.Default\n }.Build();\n\nFor more details, see the [transport selection](https://cloud.google.com/dotnet/docs/reference/help/transports) page."]]