@google-cloud/iam-credentials
Version:
Credentials client for Node.js
926 lines (769 loc) • 341 kB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace iam. */
namespace iam {
/** Namespace credentials. */
namespace credentials {
/** Namespace v1. */
namespace v1 {
/** Properties of a GenerateAccessTokenRequest. */
interface IGenerateAccessTokenRequest {
/** GenerateAccessTokenRequest name */
name?: (string|null);
/** GenerateAccessTokenRequest delegates */
delegates?: (string[]|null);
/** GenerateAccessTokenRequest scope */
scope?: (string[]|null);
/** GenerateAccessTokenRequest lifetime */
lifetime?: (google.protobuf.IDuration|null);
}
/** Represents a GenerateAccessTokenRequest. */
class GenerateAccessTokenRequest implements IGenerateAccessTokenRequest {
/**
* Constructs a new GenerateAccessTokenRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.IGenerateAccessTokenRequest);
/** GenerateAccessTokenRequest name. */
public name: string;
/** GenerateAccessTokenRequest delegates. */
public delegates: string[];
/** GenerateAccessTokenRequest scope. */
public scope: string[];
/** GenerateAccessTokenRequest lifetime. */
public lifetime?: (google.protobuf.IDuration|null);
/**
* Creates a new GenerateAccessTokenRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateAccessTokenRequest instance
*/
public static create(properties?: google.iam.credentials.v1.IGenerateAccessTokenRequest): google.iam.credentials.v1.GenerateAccessTokenRequest;
/**
* Encodes the specified GenerateAccessTokenRequest message. Does not implicitly {@link google.iam.credentials.v1.GenerateAccessTokenRequest.verify|verify} messages.
* @param message GenerateAccessTokenRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.IGenerateAccessTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateAccessTokenRequest message, length delimited. Does not implicitly {@link google.iam.credentials.v1.GenerateAccessTokenRequest.verify|verify} messages.
* @param message GenerateAccessTokenRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.IGenerateAccessTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateAccessTokenRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateAccessTokenRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.GenerateAccessTokenRequest;
/**
* Decodes a GenerateAccessTokenRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateAccessTokenRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.GenerateAccessTokenRequest;
/**
* Verifies a GenerateAccessTokenRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateAccessTokenRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateAccessTokenRequest
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.GenerateAccessTokenRequest;
/**
* Creates a plain object from a GenerateAccessTokenRequest message. Also converts values to other types if specified.
* @param message GenerateAccessTokenRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.GenerateAccessTokenRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateAccessTokenRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateAccessTokenRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GenerateAccessTokenResponse. */
interface IGenerateAccessTokenResponse {
/** GenerateAccessTokenResponse accessToken */
accessToken?: (string|null);
/** GenerateAccessTokenResponse expireTime */
expireTime?: (google.protobuf.ITimestamp|null);
}
/** Represents a GenerateAccessTokenResponse. */
class GenerateAccessTokenResponse implements IGenerateAccessTokenResponse {
/**
* Constructs a new GenerateAccessTokenResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.IGenerateAccessTokenResponse);
/** GenerateAccessTokenResponse accessToken. */
public accessToken: string;
/** GenerateAccessTokenResponse expireTime. */
public expireTime?: (google.protobuf.ITimestamp|null);
/**
* Creates a new GenerateAccessTokenResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateAccessTokenResponse instance
*/
public static create(properties?: google.iam.credentials.v1.IGenerateAccessTokenResponse): google.iam.credentials.v1.GenerateAccessTokenResponse;
/**
* Encodes the specified GenerateAccessTokenResponse message. Does not implicitly {@link google.iam.credentials.v1.GenerateAccessTokenResponse.verify|verify} messages.
* @param message GenerateAccessTokenResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.IGenerateAccessTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateAccessTokenResponse message, length delimited. Does not implicitly {@link google.iam.credentials.v1.GenerateAccessTokenResponse.verify|verify} messages.
* @param message GenerateAccessTokenResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.IGenerateAccessTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateAccessTokenResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateAccessTokenResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.GenerateAccessTokenResponse;
/**
* Decodes a GenerateAccessTokenResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateAccessTokenResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.GenerateAccessTokenResponse;
/**
* Verifies a GenerateAccessTokenResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateAccessTokenResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateAccessTokenResponse
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.GenerateAccessTokenResponse;
/**
* Creates a plain object from a GenerateAccessTokenResponse message. Also converts values to other types if specified.
* @param message GenerateAccessTokenResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.GenerateAccessTokenResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateAccessTokenResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateAccessTokenResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a SignBlobRequest. */
interface ISignBlobRequest {
/** SignBlobRequest name */
name?: (string|null);
/** SignBlobRequest delegates */
delegates?: (string[]|null);
/** SignBlobRequest payload */
payload?: (Uint8Array|string|null);
}
/** Represents a SignBlobRequest. */
class SignBlobRequest implements ISignBlobRequest {
/**
* Constructs a new SignBlobRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.ISignBlobRequest);
/** SignBlobRequest name. */
public name: string;
/** SignBlobRequest delegates. */
public delegates: string[];
/** SignBlobRequest payload. */
public payload: (Uint8Array|string);
/**
* Creates a new SignBlobRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns SignBlobRequest instance
*/
public static create(properties?: google.iam.credentials.v1.ISignBlobRequest): google.iam.credentials.v1.SignBlobRequest;
/**
* Encodes the specified SignBlobRequest message. Does not implicitly {@link google.iam.credentials.v1.SignBlobRequest.verify|verify} messages.
* @param message SignBlobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.ISignBlobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SignBlobRequest message, length delimited. Does not implicitly {@link google.iam.credentials.v1.SignBlobRequest.verify|verify} messages.
* @param message SignBlobRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.ISignBlobRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SignBlobRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SignBlobRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.SignBlobRequest;
/**
* Decodes a SignBlobRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SignBlobRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.SignBlobRequest;
/**
* Verifies a SignBlobRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SignBlobRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SignBlobRequest
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.SignBlobRequest;
/**
* Creates a plain object from a SignBlobRequest message. Also converts values to other types if specified.
* @param message SignBlobRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.SignBlobRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SignBlobRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SignBlobRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a SignBlobResponse. */
interface ISignBlobResponse {
/** SignBlobResponse keyId */
keyId?: (string|null);
/** SignBlobResponse signedBlob */
signedBlob?: (Uint8Array|string|null);
}
/** Represents a SignBlobResponse. */
class SignBlobResponse implements ISignBlobResponse {
/**
* Constructs a new SignBlobResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.ISignBlobResponse);
/** SignBlobResponse keyId. */
public keyId: string;
/** SignBlobResponse signedBlob. */
public signedBlob: (Uint8Array|string);
/**
* Creates a new SignBlobResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns SignBlobResponse instance
*/
public static create(properties?: google.iam.credentials.v1.ISignBlobResponse): google.iam.credentials.v1.SignBlobResponse;
/**
* Encodes the specified SignBlobResponse message. Does not implicitly {@link google.iam.credentials.v1.SignBlobResponse.verify|verify} messages.
* @param message SignBlobResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.ISignBlobResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SignBlobResponse message, length delimited. Does not implicitly {@link google.iam.credentials.v1.SignBlobResponse.verify|verify} messages.
* @param message SignBlobResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.ISignBlobResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SignBlobResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SignBlobResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.SignBlobResponse;
/**
* Decodes a SignBlobResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SignBlobResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.SignBlobResponse;
/**
* Verifies a SignBlobResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SignBlobResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SignBlobResponse
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.SignBlobResponse;
/**
* Creates a plain object from a SignBlobResponse message. Also converts values to other types if specified.
* @param message SignBlobResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.SignBlobResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SignBlobResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SignBlobResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a SignJwtRequest. */
interface ISignJwtRequest {
/** SignJwtRequest name */
name?: (string|null);
/** SignJwtRequest delegates */
delegates?: (string[]|null);
/** SignJwtRequest payload */
payload?: (string|null);
}
/** Represents a SignJwtRequest. */
class SignJwtRequest implements ISignJwtRequest {
/**
* Constructs a new SignJwtRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.ISignJwtRequest);
/** SignJwtRequest name. */
public name: string;
/** SignJwtRequest delegates. */
public delegates: string[];
/** SignJwtRequest payload. */
public payload: string;
/**
* Creates a new SignJwtRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns SignJwtRequest instance
*/
public static create(properties?: google.iam.credentials.v1.ISignJwtRequest): google.iam.credentials.v1.SignJwtRequest;
/**
* Encodes the specified SignJwtRequest message. Does not implicitly {@link google.iam.credentials.v1.SignJwtRequest.verify|verify} messages.
* @param message SignJwtRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.ISignJwtRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SignJwtRequest message, length delimited. Does not implicitly {@link google.iam.credentials.v1.SignJwtRequest.verify|verify} messages.
* @param message SignJwtRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.ISignJwtRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SignJwtRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SignJwtRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.SignJwtRequest;
/**
* Decodes a SignJwtRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SignJwtRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.SignJwtRequest;
/**
* Verifies a SignJwtRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SignJwtRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SignJwtRequest
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.SignJwtRequest;
/**
* Creates a plain object from a SignJwtRequest message. Also converts values to other types if specified.
* @param message SignJwtRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.SignJwtRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SignJwtRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SignJwtRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a SignJwtResponse. */
interface ISignJwtResponse {
/** SignJwtResponse keyId */
keyId?: (string|null);
/** SignJwtResponse signedJwt */
signedJwt?: (string|null);
}
/** Represents a SignJwtResponse. */
class SignJwtResponse implements ISignJwtResponse {
/**
* Constructs a new SignJwtResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.ISignJwtResponse);
/** SignJwtResponse keyId. */
public keyId: string;
/** SignJwtResponse signedJwt. */
public signedJwt: string;
/**
* Creates a new SignJwtResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns SignJwtResponse instance
*/
public static create(properties?: google.iam.credentials.v1.ISignJwtResponse): google.iam.credentials.v1.SignJwtResponse;
/**
* Encodes the specified SignJwtResponse message. Does not implicitly {@link google.iam.credentials.v1.SignJwtResponse.verify|verify} messages.
* @param message SignJwtResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.ISignJwtResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SignJwtResponse message, length delimited. Does not implicitly {@link google.iam.credentials.v1.SignJwtResponse.verify|verify} messages.
* @param message SignJwtResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.ISignJwtResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SignJwtResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SignJwtResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.SignJwtResponse;
/**
* Decodes a SignJwtResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SignJwtResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.SignJwtResponse;
/**
* Verifies a SignJwtResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SignJwtResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SignJwtResponse
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.SignJwtResponse;
/**
* Creates a plain object from a SignJwtResponse message. Also converts values to other types if specified.
* @param message SignJwtResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.SignJwtResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SignJwtResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SignJwtResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GenerateIdTokenRequest. */
interface IGenerateIdTokenRequest {
/** GenerateIdTokenRequest name */
name?: (string|null);
/** GenerateIdTokenRequest delegates */
delegates?: (string[]|null);
/** GenerateIdTokenRequest audience */
audience?: (string|null);
/** GenerateIdTokenRequest includeEmail */
includeEmail?: (boolean|null);
}
/** Represents a GenerateIdTokenRequest. */
class GenerateIdTokenRequest implements IGenerateIdTokenRequest {
/**
* Constructs a new GenerateIdTokenRequest.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.IGenerateIdTokenRequest);
/** GenerateIdTokenRequest name. */
public name: string;
/** GenerateIdTokenRequest delegates. */
public delegates: string[];
/** GenerateIdTokenRequest audience. */
public audience: string;
/** GenerateIdTokenRequest includeEmail. */
public includeEmail: boolean;
/**
* Creates a new GenerateIdTokenRequest instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateIdTokenRequest instance
*/
public static create(properties?: google.iam.credentials.v1.IGenerateIdTokenRequest): google.iam.credentials.v1.GenerateIdTokenRequest;
/**
* Encodes the specified GenerateIdTokenRequest message. Does not implicitly {@link google.iam.credentials.v1.GenerateIdTokenRequest.verify|verify} messages.
* @param message GenerateIdTokenRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.IGenerateIdTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateIdTokenRequest message, length delimited. Does not implicitly {@link google.iam.credentials.v1.GenerateIdTokenRequest.verify|verify} messages.
* @param message GenerateIdTokenRequest message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.IGenerateIdTokenRequest, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateIdTokenRequest message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateIdTokenRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.GenerateIdTokenRequest;
/**
* Decodes a GenerateIdTokenRequest message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateIdTokenRequest
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.GenerateIdTokenRequest;
/**
* Verifies a GenerateIdTokenRequest message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateIdTokenRequest message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateIdTokenRequest
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.GenerateIdTokenRequest;
/**
* Creates a plain object from a GenerateIdTokenRequest message. Also converts values to other types if specified.
* @param message GenerateIdTokenRequest
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.GenerateIdTokenRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateIdTokenRequest to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateIdTokenRequest
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a GenerateIdTokenResponse. */
interface IGenerateIdTokenResponse {
/** GenerateIdTokenResponse token */
token?: (string|null);
}
/** Represents a GenerateIdTokenResponse. */
class GenerateIdTokenResponse implements IGenerateIdTokenResponse {
/**
* Constructs a new GenerateIdTokenResponse.
* @param [properties] Properties to set
*/
constructor(properties?: google.iam.credentials.v1.IGenerateIdTokenResponse);
/** GenerateIdTokenResponse token. */
public token: string;
/**
* Creates a new GenerateIdTokenResponse instance using the specified properties.
* @param [properties] Properties to set
* @returns GenerateIdTokenResponse instance
*/
public static create(properties?: google.iam.credentials.v1.IGenerateIdTokenResponse): google.iam.credentials.v1.GenerateIdTokenResponse;
/**
* Encodes the specified GenerateIdTokenResponse message. Does not implicitly {@link google.iam.credentials.v1.GenerateIdTokenResponse.verify|verify} messages.
* @param message GenerateIdTokenResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.iam.credentials.v1.IGenerateIdTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified GenerateIdTokenResponse message, length delimited. Does not implicitly {@link google.iam.credentials.v1.GenerateIdTokenResponse.verify|verify} messages.
* @param message GenerateIdTokenResponse message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.iam.credentials.v1.IGenerateIdTokenResponse, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a GenerateIdTokenResponse message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns GenerateIdTokenResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.iam.credentials.v1.GenerateIdTokenResponse;
/**
* Decodes a GenerateIdTokenResponse message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns GenerateIdTokenResponse
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.iam.credentials.v1.GenerateIdTokenResponse;
/**
* Verifies a GenerateIdTokenResponse message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a GenerateIdTokenResponse message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns GenerateIdTokenResponse
*/
public static fromObject(object: { [k: string]: any }): google.iam.credentials.v1.GenerateIdTokenResponse;
/**
* Creates a plain object from a GenerateIdTokenResponse message. Also converts values to other types if specified.
* @param message GenerateIdTokenResponse
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.iam.credentials.v1.GenerateIdTokenResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this GenerateIdTokenResponse to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for GenerateIdTokenResponse
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Represents a IAMCredentials */
class IAMCredentials extends $protobuf.rpc.Service {
/**
* Constructs a new IAMCredentials service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new IAMCredentials service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): IAMCredentials;
/**
* Calls GenerateAccessToken.
* @param request GenerateAccessTokenRequest message or plain object
* @param callback Node-style callback called with the error, if any, and GenerateAccessTokenResponse
*/
public generateAccessToken(request: google.iam.credentials.v1.IGenerateAccessTokenRequest, callback: google.iam.credentials.v1.IAMCredentials.GenerateAccessTokenCallback): void;
/**
* Calls GenerateAccessToken.
* @param request GenerateAccessTokenRequest message or plain object
* @returns Promise
*/
public generateAccessToken(request: google.iam.credentials.v1.IGenerateAccessTokenRequest): Promise<google.iam.credentials.v1.GenerateAccessTokenResponse>;
/**
* Calls GenerateIdToken.
* @param request GenerateIdTokenRequest message or plain object
* @param callback Node-style callback called with the error, if any, and GenerateIdTokenResponse
*/
public generateIdToken(request: google.iam.credentials.v1.IGenerateIdTokenRequest, callback: google.iam.credentials.v1.IAMCredentials.GenerateIdTokenCallback): void;
/**
* Calls GenerateIdToken.
* @param request GenerateIdTokenRequest message or pla