Class IAMCredentialsClientImpl (1.0.0)

Version 1.0.0

• 2.4.0 (latest)
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0
• 1.0.0

public sealed class IAMCredentialsClientImpl : IAMCredentialsClient

IAMCredentials client wrapper implementation, for convenient use.

Inheritance

System.Object > IAMCredentialsClient > IAMCredentialsClientImpl

Inherited Members

IAMCredentialsClient.DefaultEndpoint

IAMCredentialsClient.DefaultScopes

IAMCredentialsClient.CreateAsync(CancellationToken)

IAMCredentialsClient.Create()

IAMCredentialsClient.ShutdownDefaultChannelsAsync()

IAMCredentialsClient.GenerateAccessTokenAsync(GenerateAccessTokenRequest, CancellationToken)

IAMCredentialsClient.GenerateAccessToken(String, IEnumerable<String>, IEnumerable<String>, Duration, CallSettings)

IAMCredentialsClient.GenerateAccessTokenAsync(String, IEnumerable<String>, IEnumerable<String>, Duration, CallSettings)

IAMCredentialsClient.GenerateAccessTokenAsync(String, IEnumerable<String>, IEnumerable<String>, Duration, CancellationToken)

IAMCredentialsClient.GenerateAccessToken(ServiceAccountName, IEnumerable<String>, IEnumerable<String>, Duration, CallSettings)

IAMCredentialsClient.GenerateAccessTokenAsync(ServiceAccountName, IEnumerable<String>, IEnumerable<String>, Duration, CallSettings)

IAMCredentialsClient.GenerateAccessTokenAsync(ServiceAccountName, IEnumerable<String>, IEnumerable<String>, Duration, CancellationToken)

IAMCredentialsClient.GenerateIdTokenAsync(GenerateIdTokenRequest, CancellationToken)

IAMCredentialsClient.GenerateIdToken(String, IEnumerable<String>, String, Boolean, CallSettings)

IAMCredentialsClient.GenerateIdTokenAsync(String, IEnumerable<String>, String, Boolean, CallSettings)

IAMCredentialsClient.GenerateIdTokenAsync(String, IEnumerable<String>, String, Boolean, CancellationToken)

IAMCredentialsClient.GenerateIdToken(ServiceAccountName, IEnumerable<String>, String, Boolean, CallSettings)

IAMCredentialsClient.GenerateIdTokenAsync(ServiceAccountName, IEnumerable<String>, String, Boolean, CallSettings)

IAMCredentialsClient.GenerateIdTokenAsync(ServiceAccountName, IEnumerable<String>, String, Boolean, CancellationToken)

IAMCredentialsClient.SignBlobAsync(SignBlobRequest, CancellationToken)

IAMCredentialsClient.SignBlob(String, IEnumerable<String>, ByteString, CallSettings)

IAMCredentialsClient.SignBlobAsync(String, IEnumerable<String>, ByteString, CallSettings)

IAMCredentialsClient.SignBlobAsync(String, IEnumerable<String>, ByteString, CancellationToken)

IAMCredentialsClient.SignBlob(ServiceAccountName, IEnumerable<String>, ByteString, CallSettings)

IAMCredentialsClient.SignBlobAsync(ServiceAccountName, IEnumerable<String>, ByteString, CallSettings)

IAMCredentialsClient.SignBlobAsync(ServiceAccountName, IEnumerable<String>, ByteString, CancellationToken)

IAMCredentialsClient.SignJwtAsync(SignJwtRequest, CancellationToken)

IAMCredentialsClient.SignJwt(String, IEnumerable<String>, String, CallSettings)

IAMCredentialsClient.SignJwtAsync(String, IEnumerable<String>, String, CallSettings)

IAMCredentialsClient.SignJwtAsync(String, IEnumerable<String>, String, CancellationToken)

IAMCredentialsClient.SignJwt(ServiceAccountName, IEnumerable<String>, String, CallSettings)

IAMCredentialsClient.SignJwtAsync(ServiceAccountName, IEnumerable<String>, String, CallSettings)

IAMCredentialsClient.SignJwtAsync(ServiceAccountName, IEnumerable<String>, String, CancellationToken)

System.Object.ToString()

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace

Google.Cloud.Iam.Credentials.V1

Assembly

Google.Cloud.Iam.Credentials.V1.dll

Remarks

A service account is a special type of Google account that belongs to your application or a virtual machine (VM), instead of to an individual end user. Your application assumes the identity of the service account to call Google APIs, so that the users aren't directly involved.

Service account credentials are used to temporarily assume the identity of the service account. Supported credential types include OAuth 2.0 access tokens, OpenID Connect ID tokens, self-signed JSON Web Tokens (JWTs), and more.

Constructors

IAMCredentialsClientImpl(IAMCredentials.IAMCredentialsClient, IAMCredentialsSettings)

public IAMCredentialsClientImpl(IAMCredentials.IAMCredentialsClient grpcClient, IAMCredentialsSettings settings)

Constructs a client wrapper for the IAMCredentials service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	IAMCredentials.IAMCredentialsClient The underlying gRPC client.
settings	IAMCredentialsSettings The base IAMCredentialsSettings used within this client.

Properties

GrpcClient

public override IAMCredentials.IAMCredentialsClient GrpcClient { get; }

The underlying gRPC IAMCredentials client

Property Value
Type	Description
IAMCredentials.IAMCredentialsClient

Overrides

IAMCredentialsClient.GrpcClient

Methods

GenerateAccessToken(GenerateAccessTokenRequest, CallSettings)

public override GenerateAccessTokenResponse GenerateAccessToken(GenerateAccessTokenRequest request, CallSettings callSettings = null)

Generates an OAuth 2.0 access token for a service account.

Parameters
Name	Description
request	GenerateAccessTokenRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GenerateAccessTokenResponse	The RPC response.

Overrides

IAMCredentialsClient.GenerateAccessToken(GenerateAccessTokenRequest, CallSettings)

GenerateAccessTokenAsync(GenerateAccessTokenRequest, CallSettings)

public override Task<GenerateAccessTokenResponse> GenerateAccessTokenAsync(GenerateAccessTokenRequest request, CallSettings callSettings = null)

Generates an OAuth 2.0 access token for a service account.

Parameters
Name	Description
request	GenerateAccessTokenRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<GenerateAccessTokenResponse>	A Task containing the RPC response.

Overrides

IAMCredentialsClient.GenerateAccessTokenAsync(GenerateAccessTokenRequest, CallSettings)

GenerateIdToken(GenerateIdTokenRequest, CallSettings)

public override GenerateIdTokenResponse GenerateIdToken(GenerateIdTokenRequest request, CallSettings callSettings = null)

Generates an OpenID Connect ID token for a service account.

Parameters
Name	Description
request	GenerateIdTokenRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
GenerateIdTokenResponse	The RPC response.

Overrides

IAMCredentialsClient.GenerateIdToken(GenerateIdTokenRequest, CallSettings)

GenerateIdTokenAsync(GenerateIdTokenRequest, CallSettings)

public override Task<GenerateIdTokenResponse> GenerateIdTokenAsync(GenerateIdTokenRequest request, CallSettings callSettings = null)

Generates an OpenID Connect ID token for a service account.

Parameters
Name	Description
request	GenerateIdTokenRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<GenerateIdTokenResponse>	A Task containing the RPC response.

Overrides

IAMCredentialsClient.GenerateIdTokenAsync(GenerateIdTokenRequest, CallSettings)

SignBlob(SignBlobRequest, CallSettings)

public override SignBlobResponse SignBlob(SignBlobRequest request, CallSettings callSettings = null)

Signs a blob using a service account's system-managed private key.

Parameters
Name	Description
request	SignBlobRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SignBlobResponse	The RPC response.

Overrides

IAMCredentialsClient.SignBlob(SignBlobRequest, CallSettings)

SignBlobAsync(SignBlobRequest, CallSettings)

public override Task<SignBlobResponse> SignBlobAsync(SignBlobRequest request, CallSettings callSettings = null)

Signs a blob using a service account's system-managed private key.

Parameters
Name	Description
request	SignBlobRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<SignBlobResponse>	A Task containing the RPC response.

Overrides

IAMCredentialsClient.SignBlobAsync(SignBlobRequest, CallSettings)

SignJwt(SignJwtRequest, CallSettings)

public override SignJwtResponse SignJwt(SignJwtRequest request, CallSettings callSettings = null)

Signs a JWT using a service account's system-managed private key.

Parameters
Name	Description
request	SignJwtRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
SignJwtResponse	The RPC response.

Overrides

IAMCredentialsClient.SignJwt(SignJwtRequest, CallSettings)

SignJwtAsync(SignJwtRequest, CallSettings)

public override Task<SignJwtResponse> SignJwtAsync(SignJwtRequest request, CallSettings callSettings = null)

Signs a JWT using a service account's system-managed private key.

Parameters
Name	Description
request	SignJwtRequest The request object containing all of the parameters for the API call.
callSettings	Google.Api.Gax.Grpc.CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
System.Threading.Tasks.Task<SignJwtResponse>	A Task containing the RPC response.

Overrides

IAMCredentialsClient.SignJwtAsync(SignJwtRequest, CallSettings)