Send feedback
Class v1.IdentityAwareProxyOAuthServiceClient (1.0.1) Stay organized with collections
Save and categorize content based on your preferences.
Version 1.0.1 keyboard_arrow_down
API to programmatically create, list and retrieve Identity Aware Proxy (IAP) OAuth brands; and create, retrieve, delete and reset-secret of IAP OAuth clients. v1
Package
@google-cloud/iap!
Constructors
(constructor)(opts)
constructor
(
opts
?:
ClientOptions
);
Construct an instance of IdentityAwareProxyOAuthServiceClient.
Parameter
Properties
apiEndpoint
static
get
apiEndpoint
()
:
string
;
The DNS address for this API service - same as servicePath(), exists for compatibility reasons.
Property Value
auth
auth
:
gax
.
GoogleAuth
;
Property Value
descriptors
descriptors
:
Descriptors
;
Property Value
identityAwareProxyOAuthServiceStub
identityAwareProxyOAuthServiceStub
?:
Promise
< {
[
name
:
string
]
:
Function
;
}>;
Property Value
innerApiCalls
innerApiCalls
:
{
[
name
:
string
]
:
Function
;
};
Property Value
port
static
get
port
()
:
number
;
The port for this API service.
Property Value
scopes
static
get
scopes
()
:
string
[];
The scopes needed to make gRPC calls for every method defined in this service.
Property Value
servicePath
static
get
servicePath
()
:
string
;
The DNS address for this API service.
Property Value
warn
warn
:
(
code
:
string
,
message
:
string
,
warnType
?:
string
)
=
>
void
;
Property Value
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.
createBrand(request, options)
createBrand
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateBrandRequest
options
CallOptions
Returns
createBrand(request, options, callback)
createBrand
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateBrandRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IBrand
, protos. google.cloud.iap.v1.ICreateBrandRequest
| null | undefined, {} | null | undefined>
Returns
createBrand(request, callback)
createBrand
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateBrandRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateBrandRequest
callback
Callback
<protos. google.cloud.iap.v1.IBrand
, protos. google.cloud.iap.v1.ICreateBrandRequest
| null | undefined, {} | null | undefined>
Returns
createIdentityAwareProxyClient(request, options)
createIdentityAwareProxyClient
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
(
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest
options
CallOptions
Returns
createIdentityAwareProxyClient(request, options, callback)
createIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
createIdentityAwareProxyClient(request, callback)
createIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
ICreateIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.ICreateIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
deleteIdentityAwareProxyClient(request, options)
deleteIdentityAwareProxyClient
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
protobuf
.
IEmpty
,
(
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest
options
CallOptions
Returns
deleteIdentityAwareProxyClient(request, options, callback)
deleteIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest
options
CallOptions
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
deleteIdentityAwareProxyClient(request, callback)
deleteIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
,
callback
:
Callback<protos
.
google
.
protobuf
.
IEmpty
,
protos
.
google
.
cloud
.
iap
.
v1
.
IDeleteIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest
callback
Callback
<protos. google.protobuf.IEmpty
, protos. google.cloud.iap.v1.IDeleteIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
getBrand(request, options)
getBrand
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetBrandRequest
options
CallOptions
Returns
getBrand(request, options, callback)
getBrand
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetBrandRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IBrand
, protos. google.cloud.iap.v1.IGetBrandRequest
| null | undefined, {} | null | undefined>
Returns
getBrand(request, callback)
getBrand
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IBrand
,
protos
.
google
.
cloud
.
iap
.
v1
.
IGetBrandRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetBrandRequest
callback
Callback
<protos. google.cloud.iap.v1.IBrand
, protos. google.cloud.iap.v1.IGetBrandRequest
| null | undefined, {} | null | undefined>
Returns
getIdentityAwareProxyClient(request, options)
getIdentityAwareProxyClient
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
(
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest
options
CallOptions
Returns
getIdentityAwareProxyClient(request, options, callback)
getIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
getIdentityAwareProxyClient(request, callback)
getIdentityAwareProxyClient
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
IGetIdentityAwareProxyClientRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.IGetIdentityAwareProxyClientRequest
| null | undefined, {} | null | undefined>
Returns
getProjectId()
getProjectId
()
:
Promise<string>
;
Returns
getProjectId(callback)
getProjectId
(
callback
:
Callback<string
,
undefined
,
undefined
> )
:
void
;
Parameter Name
Description
callback
Callback
<string, undefined, undefined>
Returns
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.
listBrands(request, options)
listBrands
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsResponse
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
|
undefined
,
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListBrandsRequest
options
CallOptions
Returns
listBrands(request, options, callback)
listBrands
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsResponse
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListBrandsRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IListBrandsResponse
, protos. google.cloud.iap.v1.IListBrandsRequest
| null | undefined, {} | null | undefined>
Returns
listBrands(request, callback)
listBrands
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsResponse
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListBrandsRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListBrandsRequest
callback
Callback
<protos. google.cloud.iap.v1.IListBrandsResponse
, protos. google.cloud.iap.v1.IListBrandsRequest
| null | undefined, {} | null | undefined>
Returns
listIdentityAwareProxyClients(request, options)
listIdentityAwareProxyClients
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
[],
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
|
null
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsResponse
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
options
CallOptions
Returns
listIdentityAwareProxyClients(request, options, callback)
listIdentityAwareProxyClients
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
options
:
CallOptions
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
options
CallOptions
callback
PaginationCallback
<protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
, protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsResponse
| null | undefined, protos. google.cloud.iap.v1.IIdentityAwareProxyClient
>
Returns
listIdentityAwareProxyClients(request, callback)
listIdentityAwareProxyClients
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
callback
:
PaginationCallback<protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsResponse
|
null
|
undefined
,
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
callback
PaginationCallback
<protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
, protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsResponse
| null | undefined, protos. google.cloud.iap.v1.IIdentityAwareProxyClient
>
Returns
listIdentityAwareProxyClientsAsync(request, options)
listIdentityAwareProxyClientsAsync
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
options
?:
CallOptions
)
:
AsyncIterable<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
> ;
Equivalent to listIdentityAwareProxyClients
, but returns an iterable object.
for
- await
- of
syntax is used with the iterable to get response elements on-demand.
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
AsyncIterable
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
>
{Object} An iterable Object that allows [async iteration](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols). When you iterate the returned iterable, each element will be an object representing [IdentityAwareProxyClient]. The API will be called under the hood as needed, once per the page, so you can stop the iteration when you don't need more results. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
listIdentityAwareProxyClientsStream(request, options)
listIdentityAwareProxyClientsStream
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IListIdentityAwareProxyClientsRequest
,
options
?:
CallOptions
)
:
Transform
;
Equivalent to method.name.toCamelCase()
, but returns a NodeJS Stream object.
Parameters Name
Description
request
protos. google.cloud.iap.v1.IListIdentityAwareProxyClientsRequest
The request object that will be sent.
options
CallOptions
Call options. See CallOptions
for more details.
Returns Type
Description
Transform
{Stream} An object stream which emits an object representing [IdentityAwareProxyClient] on 'data' event. The client library will perform auto-pagination by default: it will call the API as many times as needed. Note that it can affect your quota. We recommend using listIdentityAwareProxyClientsAsync()
method described below for async iteration which you can stop as needed. Please see the [documentation](https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination) for more details and examples.
resetIdentityAwareProxyClientSecret(request, options)
resetIdentityAwareProxyClientSecret
(
request
?:
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
,
options
?:
CallOptions
)
:
Promise
< [
protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
(
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
|
undefined
),
{}
|
undefined
]>;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest
options
CallOptions
Returns
resetIdentityAwareProxyClientSecret(request, options, callback)
resetIdentityAwareProxyClientSecret
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
,
options
:
CallOptions
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest
options
CallOptions
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest
| null | undefined, {} | null | undefined>
Returns
resetIdentityAwareProxyClientSecret(request, callback)
resetIdentityAwareProxyClientSecret
(
request
:
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
,
callback
:
Callback<protos
.
google
.
cloud
.
iap
.
v1
.
IIdentityAwareProxyClient
,
protos
.
google
.
cloud
.
iap
.
v1
.
IResetIdentityAwareProxyClientSecretRequest
|
null
|
undefined
,
{}
|
null
|
undefined
> )
:
void
;
Parameters Name
Description
request
protos. google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest
callback
Callback
<protos. google.cloud.iap.v1.IIdentityAwareProxyClient
, protos. google.cloud.iap.v1.IResetIdentityAwareProxyClientSecretRequest
| null | undefined, {} | null | undefined>
Returns
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License
, and code samples are licensed under the Apache 2.0 License
. For details, see the Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-09-04 UTC.
Need to tell us more?
[[["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-09-04 UTC."],[],[],null,[]]