Class v1beta.OsLoginServiceClient (3.2.6)

Version 3.2.6

• 5.4.0 (latest)
• 5.3.0
• 5.2.0
• 4.1.2
• 4.0.4
• 3.3.1
• 3.2.6

Cloud OS Login API

The Cloud OS Login API allows you to manage users and their associated SSH public keys for logging into virtual machines on Google Cloud Platform. v1beta

Package

@google-cloud/os-login!

Constructors

(constructor)(opts)

constructor(opts?: ClientOptions);

Construct an instance of OsLoginServiceClient.

Parameter

Name	Description
opts	ClientOptions

Properties

apiEndpoint

static get apiEndpoint(): string;

The DNS address for this API service - same as servicePath(), exists for compatibility reasons.

Property Value

Type	Description
string

auth

auth: gax.GoogleAuth;

Property Value

Type	Description
gax.GoogleAuth

descriptors

descriptors: Descriptors;

Property Value

Type	Description
Descriptors

innerApiCalls

innerApiCalls: {
        [name: string]: Function;
    };

Property Value

Type	Description
{ [name: string]: Function; }

osLoginServiceStub

osLoginServiceStub?: Promise<{
        [name: string]: Function;
    }>;

Property Value

Type	Description
Promise<{ [name: string]: Function; }>

pathTemplates

pathTemplates: {
        [name: string]: gax.PathTemplate;
    };

Property Value

Type	Description
{ [name: string]: gax.PathTemplate; }

port

static get port(): number;

The port for this API service.

Property Value

Type	Description
number

scopes

static get scopes(): string[];

The scopes needed to make gRPC calls for every method defined in this service.

Property Value

Type	Description
string[]

servicePath

static get servicePath(): string;

The DNS address for this API service.

Property Value

Type	Description
string

warn

warn: (code: string, message: string, warnType?: string) => void;

Property Value

Type	Description
(code: string, message: string, warnType?: string) => void

Methods

close()

close(): Promise<void>;

Terminate the gRPC channel and close the client.

The client will no longer be usable and all future behavior is undefined.

Returns

Type	Description
Promise<void>	{Promise} A promise that resolves when the client is closed.

deletePosixAccount(request, options)

deletePosixAccount(request?: protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | undefined, {} | undefined]>

deletePosixAccount(request, options, callback)

deletePosixAccount(request: protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deletePosixAccount(request, callback)

deletePosixAccount(request: protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeletePosixAccountRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteSshPublicKey(request, options)

deleteSshPublicKey(request?: protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest, options?: CallOptions): Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | undefined, {} | undefined]>

deleteSshPublicKey(request, options, callback)

deleteSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest, options: CallOptions, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest
options	CallOptions
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

deleteSshPublicKey(request, callback)

deleteSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest, callback: Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest
callback	Callback<protos.google.protobuf.IEmpty, protos.google.cloud.oslogin.v1beta.IDeleteSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getLoginProfile(request, options)

getLoginProfile(request?: protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest, options?: CallOptions): Promise<[protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | undefined, {} | undefined]>

getLoginProfile(request, options, callback)

getLoginProfile(request: protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest
options	CallOptions
callback	Callback<protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getLoginProfile(request, callback)

getLoginProfile(request: protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest, callback: Callback<protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest
callback	Callback<protos.google.cloud.oslogin.v1beta.ILoginProfile, protos.google.cloud.oslogin.v1beta.IGetLoginProfileRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getProjectId()

getProjectId(): Promise<string>;

Returns

Type	Description
Promise<string>

getProjectId(callback)

getProjectId(callback: Callback<string, undefined, undefined>): void;

Parameter

Name	Description
callback	Callback<string, undefined, undefined>

Returns

Type	Description
void

getSshPublicKey(request, options)

getSshPublicKey(request?: protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | undefined, {} | undefined]>

getSshPublicKey(request, options, callback)

getSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest
options	CallOptions
callback	Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

getSshPublicKey(request, callback)

getSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest, callback: Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest
callback	Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IGetSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

importSshPublicKey(request, options)

importSshPublicKey(request?: protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | undefined, {} | undefined]>

importSshPublicKey(request, options, callback)

importSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest
options	CallOptions
callback	Callback<protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

importSshPublicKey(request, callback)

importSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest, callback: Callback<protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest
callback	Callback<protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyResponse, protos.google.cloud.oslogin.v1beta.IImportSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

initialize()

initialize(): Promise<{
        [name: string]: Function;
    }>;

Initialize the client. Performs asynchronous operations (such as authentication) and prepares the client. This function will be called automatically when any class method is called for the first time, but if you need to initialize it before calling an actual method, feel free to call initialize() directly.

You can await on this method if you want to make sure the client is initialized.

Returns

Type	Description
Promise<{ [name: string]: Function; }>	{Promise} A promise that resolves to an authenticated service stub.

matchFingerprintFromSshPublicKeyName(sshPublicKeyName)

matchFingerprintFromSshPublicKeyName(sshPublicKeyName: string): string | number;

Parse the fingerprint from SshPublicKey resource.

Parameter

Name	Description
sshPublicKeyName	string A fully-qualified path representing SshPublicKey resource.

Returns

Type	Description
string | number	{string} A string representing the fingerprint.

matchProjectFromPosixAccountName(posixAccountName)

matchProjectFromPosixAccountName(posixAccountName: string): string | number;

Parse the project from PosixAccount resource.

Parameter

Name	Description
posixAccountName	string A fully-qualified path representing PosixAccount resource.

Returns

Type	Description
string | number	{string} A string representing the project.

matchUserFromPosixAccountName(posixAccountName)

matchUserFromPosixAccountName(posixAccountName: string): string | number;

Parse the user from PosixAccount resource.

Parameter

Name	Description
posixAccountName	string A fully-qualified path representing PosixAccount resource.

Returns

Type	Description
string | number	{string} A string representing the user.

matchUserFromSshPublicKeyName(sshPublicKeyName)

matchUserFromSshPublicKeyName(sshPublicKeyName: string): string | number;

Parse the user from SshPublicKey resource.

Parameter

Name	Description
sshPublicKeyName	string A fully-qualified path representing SshPublicKey resource.

Returns

Type	Description
string | number	{string} A string representing the user.

matchUserFromUserName(userName)

matchUserFromUserName(userName: string): string | number;

Parse the user from User resource.

Parameter

Name	Description
userName	string A fully-qualified path representing User resource.

Returns

Type	Description
string | number	{string} A string representing the user.

posixAccountPath(user, project)

posixAccountPath(user: string, project: string): string;

Return a fully-qualified posixAccount resource name string.

Parameters

Name	Description
user	string
project	string

Returns

Type	Description
string	{string} Resource name string.

sshPublicKeyPath(user, fingerprint)

sshPublicKeyPath(user: string, fingerprint: string): string;

Return a fully-qualified sshPublicKey resource name string.

Parameters

Name	Description
user	string
fingerprint	string

Returns

Type	Description
string	{string} Resource name string.

updateSshPublicKey(request, options)

updateSshPublicKey(request?: protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest, options?: CallOptions): Promise<[protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | undefined, {} | undefined]>;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest
options	CallOptions

Returns

Type	Description
Promise<[protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | undefined, {} | undefined]>

updateSshPublicKey(request, options, callback)

updateSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest, options: CallOptions, callback: Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest
options	CallOptions
callback	Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

updateSshPublicKey(request, callback)

updateSshPublicKey(request: protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest, callback: Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | null | undefined, {} | null | undefined>): void;

Parameters

Name	Description
request	protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest
callback	Callback<protos.google.cloud.oslogin.common.ISshPublicKey, protos.google.cloud.oslogin.v1beta.IUpdateSshPublicKeyRequest | null | undefined, {} | null | undefined>

Returns

Type	Description
void

userPath(user)

userPath(user: string): string;

Return a fully-qualified user resource name string.

Parameter

Name	Description
user	string

Returns

Type	Description
string	{string} Resource name string.