Class protos.google.cloud.agentidentity.v1.AuthProviderService (0.1.1)

Represents an AuthProviderService

Inheritance

$protobuf.rpc.Service > protos.google.cloud.agentidentity.v1.AuthProviderService

Package

@google-cloud/agentidentity

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new AuthProviderService service.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): AuthProviderService;

Creates new AuthProviderService service using the specified rpc implementation.

Parameters
Name Description
rpcImpl $protobuf.RPCImpl

RPC implementation

requestDelimited boolean

Whether requests are length-delimited

responseDelimited boolean

Whether responses are length-delimited

Returns
Type Description
AuthProviderService

RPC service. Useful where requests and/or responses are streamed.

createAuthProvider(request, callback)

public createAuthProvider(request: google.cloud.agentidentity.v1.ICreateAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.CreateAuthProviderCallback): void;

Calls CreateAuthProvider.

Parameters
Name Description
request ICreateAuthProviderRequest

CreateAuthProviderRequest message or plain object

callback CreateAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

createAuthProvider(request)

public createAuthProvider(request: google.cloud.agentidentity.v1.ICreateAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls CreateAuthProvider.

Parameter
Name Description
request ICreateAuthProviderRequest

CreateAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise

deleteAuthorization(request, callback)

public deleteAuthorization(request: google.cloud.agentidentity.v1.IDeleteAuthorizationRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.DeleteAuthorizationCallback): void;

Calls DeleteAuthorization.

Parameters
Name Description
request IDeleteAuthorizationRequest

DeleteAuthorizationRequest message or plain object

callback DeleteAuthorizationCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteAuthorization(request)

public deleteAuthorization(request: google.cloud.agentidentity.v1.IDeleteAuthorizationRequest): Promise<google.protobuf.Empty>;

Calls DeleteAuthorization.

Parameter
Name Description
request IDeleteAuthorizationRequest

DeleteAuthorizationRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

deleteAuthProvider(request, callback)

public deleteAuthProvider(request: google.cloud.agentidentity.v1.IDeleteAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.DeleteAuthProviderCallback): void;

Calls DeleteAuthProvider.

Parameters
Name Description
request IDeleteAuthProviderRequest

DeleteAuthProviderRequest message or plain object

callback DeleteAuthProviderCallback

Node-style callback called with the error, if any, and Empty

Returns
Type Description
void

deleteAuthProvider(request)

public deleteAuthProvider(request: google.cloud.agentidentity.v1.IDeleteAuthProviderRequest): Promise<google.protobuf.Empty>;

Calls DeleteAuthProvider.

Parameter
Name Description
request IDeleteAuthProviderRequest

DeleteAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.protobuf.Empty>

Promise

disableAuthProvider(request, callback)

public disableAuthProvider(request: google.cloud.agentidentity.v1.IDisableAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.DisableAuthProviderCallback): void;

Calls DisableAuthProvider.

Parameters
Name Description
request IDisableAuthProviderRequest

DisableAuthProviderRequest message or plain object

callback DisableAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

disableAuthProvider(request)

public disableAuthProvider(request: google.cloud.agentidentity.v1.IDisableAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls DisableAuthProvider.

Parameter
Name Description
request IDisableAuthProviderRequest

DisableAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise

enableAuthProvider(request, callback)

public enableAuthProvider(request: google.cloud.agentidentity.v1.IEnableAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.EnableAuthProviderCallback): void;

Calls EnableAuthProvider.

Parameters
Name Description
request IEnableAuthProviderRequest

EnableAuthProviderRequest message or plain object

callback EnableAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

enableAuthProvider(request)

public enableAuthProvider(request: google.cloud.agentidentity.v1.IEnableAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls EnableAuthProvider.

Parameter
Name Description
request IEnableAuthProviderRequest

EnableAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise

getAccessSummary(request, callback)

public getAccessSummary(request: google.cloud.agentidentity.v1.IGetAccessSummaryRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.GetAccessSummaryCallback): void;

Calls GetAccessSummary.

Parameters
Name Description
request IGetAccessSummaryRequest

GetAccessSummaryRequest message or plain object

callback GetAccessSummaryCallback

Node-style callback called with the error, if any, and AccessSummary

Returns
Type Description
void

getAccessSummary(request)

public getAccessSummary(request: google.cloud.agentidentity.v1.IGetAccessSummaryRequest): Promise<google.cloud.agentidentity.v1.AccessSummary>;

Calls GetAccessSummary.

Parameter
Name Description
request IGetAccessSummaryRequest

GetAccessSummaryRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AccessSummary>

Promise

getAuthorization(request, callback)

public getAuthorization(request: google.cloud.agentidentity.v1.IGetAuthorizationRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.GetAuthorizationCallback): void;

Calls GetAuthorization.

Parameters
Name Description
request IGetAuthorizationRequest

GetAuthorizationRequest message or plain object

callback GetAuthorizationCallback

Node-style callback called with the error, if any, and Authorization

Returns
Type Description
void

getAuthorization(request)

public getAuthorization(request: google.cloud.agentidentity.v1.IGetAuthorizationRequest): Promise<google.cloud.agentidentity.v1.Authorization>;

Calls GetAuthorization.

Parameter
Name Description
request IGetAuthorizationRequest

GetAuthorizationRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.Authorization>

Promise

getAuthProvider(request, callback)

public getAuthProvider(request: google.cloud.agentidentity.v1.IGetAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.GetAuthProviderCallback): void;

Calls GetAuthProvider.

Parameters
Name Description
request IGetAuthProviderRequest

GetAuthProviderRequest message or plain object

callback GetAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

getAuthProvider(request)

public getAuthProvider(request: google.cloud.agentidentity.v1.IGetAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls GetAuthProvider.

Parameter
Name Description
request IGetAuthProviderRequest

GetAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise

listAccessSummaries(request, callback)

public listAccessSummaries(request: google.cloud.agentidentity.v1.IListAccessSummariesRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.ListAccessSummariesCallback): void;

Calls ListAccessSummaries.

Parameters
Name Description
request IListAccessSummariesRequest

ListAccessSummariesRequest message or plain object

callback ListAccessSummariesCallback

Node-style callback called with the error, if any, and ListAccessSummariesResponse

Returns
Type Description
void

listAccessSummaries(request)

public listAccessSummaries(request: google.cloud.agentidentity.v1.IListAccessSummariesRequest): Promise<google.cloud.agentidentity.v1.ListAccessSummariesResponse>;

Calls ListAccessSummaries.

Parameter
Name Description
request IListAccessSummariesRequest

ListAccessSummariesRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.ListAccessSummariesResponse>

Promise

listAuthorizations(request, callback)

public listAuthorizations(request: google.cloud.agentidentity.v1.IListAuthorizationsRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.ListAuthorizationsCallback): void;

Calls ListAuthorizations.

Parameters
Name Description
request IListAuthorizationsRequest

ListAuthorizationsRequest message or plain object

callback ListAuthorizationsCallback

Node-style callback called with the error, if any, and ListAuthorizationsResponse

Returns
Type Description
void

listAuthorizations(request)

public listAuthorizations(request: google.cloud.agentidentity.v1.IListAuthorizationsRequest): Promise<google.cloud.agentidentity.v1.ListAuthorizationsResponse>;

Calls ListAuthorizations.

Parameter
Name Description
request IListAuthorizationsRequest

ListAuthorizationsRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.ListAuthorizationsResponse>

Promise

listAuthProviders(request, callback)

public listAuthProviders(request: google.cloud.agentidentity.v1.IListAuthProvidersRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.ListAuthProvidersCallback): void;

Calls ListAuthProviders.

Parameters
Name Description
request IListAuthProvidersRequest

ListAuthProvidersRequest message or plain object

callback ListAuthProvidersCallback

Node-style callback called with the error, if any, and ListAuthProvidersResponse

Returns
Type Description
void

listAuthProviders(request)

public listAuthProviders(request: google.cloud.agentidentity.v1.IListAuthProvidersRequest): Promise<google.cloud.agentidentity.v1.ListAuthProvidersResponse>;

Calls ListAuthProviders.

Parameter
Name Description
request IListAuthProvidersRequest

ListAuthProvidersRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.ListAuthProvidersResponse>

Promise

queryAuthProviders(request, callback)

public queryAuthProviders(request: google.cloud.agentidentity.v1.IQueryAuthProvidersRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.QueryAuthProvidersCallback): void;

Calls QueryAuthProviders.

Parameters
Name Description
request IQueryAuthProvidersRequest

QueryAuthProvidersRequest message or plain object

callback QueryAuthProvidersCallback

Node-style callback called with the error, if any, and QueryAuthProvidersResponse

Returns
Type Description
void

queryAuthProviders(request)

public queryAuthProviders(request: google.cloud.agentidentity.v1.IQueryAuthProvidersRequest): Promise<google.cloud.agentidentity.v1.QueryAuthProvidersResponse>;

Calls QueryAuthProviders.

Parameter
Name Description
request IQueryAuthProvidersRequest

QueryAuthProvidersRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.QueryAuthProvidersResponse>

Promise

queryWorkloads(request, callback)

public queryWorkloads(request: google.cloud.agentidentity.v1.IQueryWorkloadsRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.QueryWorkloadsCallback): void;

Calls QueryWorkloads.

Parameters
Name Description
request IQueryWorkloadsRequest

QueryWorkloadsRequest message or plain object

callback QueryWorkloadsCallback

Node-style callback called with the error, if any, and QueryWorkloadsResponse

Returns
Type Description
void

queryWorkloads(request)

public queryWorkloads(request: google.cloud.agentidentity.v1.IQueryWorkloadsRequest): Promise<google.cloud.agentidentity.v1.QueryWorkloadsResponse>;

Calls QueryWorkloads.

Parameter
Name Description
request IQueryWorkloadsRequest

QueryWorkloadsRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.QueryWorkloadsResponse>

Promise

revokeAuthorization(request, callback)

public revokeAuthorization(request: google.cloud.agentidentity.v1.IRevokeAuthorizationRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.RevokeAuthorizationCallback): void;

Calls RevokeAuthorization.

Parameters
Name Description
request IRevokeAuthorizationRequest

RevokeAuthorizationRequest message or plain object

callback RevokeAuthorizationCallback

Node-style callback called with the error, if any, and RevokeAuthorizationResponse

Returns
Type Description
void

revokeAuthorization(request)

public revokeAuthorization(request: google.cloud.agentidentity.v1.IRevokeAuthorizationRequest): Promise<google.cloud.agentidentity.v1.RevokeAuthorizationResponse>;

Calls RevokeAuthorization.

Parameter
Name Description
request IRevokeAuthorizationRequest

RevokeAuthorizationRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.RevokeAuthorizationResponse>

Promise

undeleteAuthProvider(request, callback)

public undeleteAuthProvider(request: google.cloud.agentidentity.v1.IUndeleteAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.UndeleteAuthProviderCallback): void;

Calls UndeleteAuthProvider.

Parameters
Name Description
request IUndeleteAuthProviderRequest

UndeleteAuthProviderRequest message or plain object

callback UndeleteAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

undeleteAuthProvider(request)

public undeleteAuthProvider(request: google.cloud.agentidentity.v1.IUndeleteAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls UndeleteAuthProvider.

Parameter
Name Description
request IUndeleteAuthProviderRequest

UndeleteAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise

updateAuthProvider(request, callback)

public updateAuthProvider(request: google.cloud.agentidentity.v1.IUpdateAuthProviderRequest, callback: google.cloud.agentidentity.v1.AuthProviderService.UpdateAuthProviderCallback): void;

Calls UpdateAuthProvider.

Parameters
Name Description
request IUpdateAuthProviderRequest

UpdateAuthProviderRequest message or plain object

callback UpdateAuthProviderCallback

Node-style callback called with the error, if any, and AuthProvider

Returns
Type Description
void

updateAuthProvider(request)

public updateAuthProvider(request: google.cloud.agentidentity.v1.IUpdateAuthProviderRequest): Promise<google.cloud.agentidentity.v1.AuthProvider>;

Calls UpdateAuthProvider.

Parameter
Name Description
request IUpdateAuthProviderRequest

UpdateAuthProviderRequest message or plain object

Returns
Type Description
Promise<google.cloud.agentidentity.v1.AuthProvider>

Promise