google_api_iap v0.2.0 GoogleApi.IAP.V1.Api.Oauth View Source
API calls for all endpoints tagged Oauth
.
Link to this section Summary
Functions
Constructs a new OAuth brand for the project if one does not exists. The created brand is 'internal only', meaning that OAuth clients created under it only accept requests from users who belong to the same GSuites account as the project. The brand is created in un-reviewed status. NOTE: the 'internal_only' can be manually changed in Pantheon UI. Requires that brand does not already exists for the project.
Retrieves the OAuth brand of the project.
Creates an Identity Aware Proxy (IAP) OAuth client, the client is owned by IAP. Requires that the brand for the project exists and that it is set for internal only use.
Deletes an Identity Aware Proxy (IAP) OAuth client. Useful if the secret was compromised. Requires that the client is owned by IAP.
Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.
Lists the existing clients for the brand.
Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.
Lists the existing brands for the project.
Link to this section Functions
iap_oauth_projects_brands_create(connection, projects_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.Brand.t()} | {:error, Tesla.Env.t()}
Constructs a new OAuth brand for the project if one does not exists. The created brand is 'internal only', meaning that OAuth clients created under it only accept requests from users who belong to the same GSuites account as the project. The brand is created in un-reviewed status. NOTE: the 'internal_only' can be manually changed in Pantheon UI. Requires that brand does not already exists for the project.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. GCP Project number/id under which the brand is to be created. In the following format: projects/{project_number/id}.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAP.V1.Model.Brand.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.Brand{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_get(connection, projects_id, brands_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.Brand.t()} | {:error, Tesla.Env.t()}
Retrieves the OAuth brand of the project.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. Name of the brand to be fetched. In the following format: projects/{project_number/id}/brands/{brand}.brands_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.Brand{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_identity_aware_proxy_clients_create(connection, projects_id, brands_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_identity_aware_proxy_clients_create( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.IdentityAwareProxyClient.t()} | {:error, Tesla.Env.t()}
Creates an Identity Aware Proxy (IAP) OAuth client, the client is owned by IAP. Requires that the brand for the project exists and that it is set for internal only use.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. Path to create the client in. In the following format: projects/{project_number/id}/brands/{brand}. The project must belong to a GSuite account.brands_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAP.V1.Model.IdentityAwareProxyClient.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.IdentityAwareProxyClient{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_identity_aware_proxy_clients_delete(connection, projects_id, brands_id, identity_aware_proxy_clients_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_identity_aware_proxy_clients_delete( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes an Identity Aware Proxy (IAP) OAuth client. Useful if the secret was compromised. Requires that the client is owned by IAP.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. Name of the Identity Aware Proxy client to be deleted. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.brands_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.identity_aware_proxy_clients_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.Empty{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_identity_aware_proxy_clients_get(connection, projects_id, brands_id, identity_aware_proxy_clients_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_identity_aware_proxy_clients_get( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.IdentityAwareProxyClient.t()} | {:error, Tesla.Env.t()}
Retrieves an Identity Aware Proxy (IAP) OAuth client. Requires that the client is owned by IAP.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. Name of the Identity Aware Proxy client to be fetched. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.brands_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.identity_aware_proxy_clients_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.IdentityAwareProxyClient{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_identity_aware_proxy_clients_list(connection, projects_id, brands_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_identity_aware_proxy_clients_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.ListIdentityAwareProxyClientsResponse.t()} | {:error, Tesla.Env.t()}
Lists the existing clients for the brand.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. Full brand path. In the following format: projects/{project_number/id}/brands/{brand}.brands_id
(type:String.t
) - Part ofparent
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:pageSize
(type:integer()
) - The maximum number of clients to return. The service may return fewer than this value. If unspecified, at most 100 clients will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.:pageToken
(type:String.t
) - A page token, received from a previousListIdentityAwareProxyClients
call. Provide this to retrieve the subsequent page.When paginating, all other parameters provided to
ListIdentityAwareProxyClients
must match the call that provided the page token.
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.ListIdentityAwareProxyClientsResponse{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_identity_aware_proxy_clients_reset_secret(connection, projects_id, brands_id, identity_aware_proxy_clients_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_identity_aware_proxy_clients_reset_secret( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.IdentityAwareProxyClient.t()} | {:error, Tesla.Env.t()}
Resets an Identity Aware Proxy (IAP) OAuth client secret. Useful for removing obsolete clients, managing the number of clients in a given project, and cleaning up after tests. Requires that the client is owned by IAP.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofname
. Required. Name of the Identity Aware Proxy client to that will have its secret reset. In the following format: projects/{project_number/id}/brands/{brand}/identityAwareProxyClients/{client_id}.brands_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.identity_aware_proxy_clients_id
(type:String.t
) - Part ofname
. See documentation ofprojectsId
.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").:body
(type:GoogleApi.IAP.V1.Model.ResetIdentityAwareProxyClientSecretRequest.t
) -
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.IdentityAwareProxyClient{}}
on success{:error, info}
on failure
iap_oauth_projects_brands_list(connection, projects_id, optional_params \\ [], opts \\ [])
View Sourceiap_oauth_projects_brands_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.IAP.V1.Model.ListBrandsResponse.t()} | {:error, Tesla.Env.t()}
Lists the existing brands for the project.
Parameters
connection
(type:GoogleApi.IAP.V1.Connection.t
) - Connection to serverprojects_id
(type:String.t
) - Part ofparent
. Required. GCP Project number/id. In the following format: projects/{project_number/id}.optional_params
(type:keyword()
) - Optional parameters:"$.xgafv"
(type:String.t
) - V1 error format.:access_token
(type:String.t
) - OAuth access token.:alt
(type:String.t
) - Data format for response.:callback
(type:String.t
) - JSONP:fields
(type:String.t
) - Selector specifying which fields to include in a partial response.:key
(type:String.t
) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user.:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks.:quotaUser
(type:String.t
) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart").
opts
(type:keyword()
) - Call options
Returns
{:ok, %GoogleApi.IAP.V1.Model.ListBrandsResponse{}}
on success{:error, info}
on failure