View Source GoogleApi.CloudIdentity.V1.Api.InboundSamlSsoProfiles (google_api_cloud_identity v0.30.0)
API calls for all endpoints tagged InboundSamlSsoProfiles
.
Summary
Functions
Creates an InboundSamlSsoProfile for a customer.
Deletes an InboundSamlSsoProfile.
Gets an InboundSamlSsoProfile.
Adds an IdpCredential. Up to 2 credentials are allowed.
Deletes an IdpCredential.
Gets an IdpCredential.
Returns a list of IdpCredentials in an InboundSamlSsoProfile.
Lists InboundSamlSsoProfiles for a customer.
Updates an InboundSamlSsoProfile.
Functions
cloudidentity_inbound_saml_sso_profiles_create(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an InboundSamlSsoProfile for a customer.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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.CloudIdentity.V1.Model.InboundSamlSsoProfile.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an InboundSamlSsoProfile.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the InboundSamlSsoProfile to delete. Format:inboundSamlSsoProfiles/{sso_profile_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.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.InboundSamlSsoProfile.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an InboundSamlSsoProfile.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the InboundSamlSsoProfile to get. Format:inboundSamlSsoProfiles/{sso_profile_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.CloudIdentity.V1.Model.InboundSamlSsoProfile{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_idp_credentials_add(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_idp_credentials_add( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Adds an IdpCredential. Up to 2 credentials are allowed.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The InboundSamlSsoProfile that owns the IdpCredential. Format:inboundSamlSsoProfiles/{sso_profile_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.CloudIdentity.V1.Model.AddIdpCredentialRequest.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_idp_credentials_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_idp_credentials_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Deletes an IdpCredential.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the IdpCredential to delete. Format:inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_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.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_idp_credentials_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_idp_credentials_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.IdpCredential.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an IdpCredential.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the IdpCredential to retrieve. Format:inboundSamlSsoProfiles/{sso_profile_id}/idpCredentials/{idp_credential_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.CloudIdentity.V1.Model.IdpCredential{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_idp_credentials_list(connection, parent, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_idp_credentials_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ListIdpCredentialsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Returns a list of IdpCredentials in an InboundSamlSsoProfile.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
parent
(type:String.t
) - Required. The parent, which owns this collection ofIdpCredential
s. Format:inboundSamlSsoProfiles/{sso_profile_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"). -
:pageSize
(type:integer()
) - The maximum number ofIdpCredential
s to return. The service may return fewer than this value. -
:pageToken
(type:String.t
) - A page token, received from a previousListIdpCredentials
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListIdpCredentials
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ListIdpCredentialsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_list(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ListInboundSamlSsoProfilesResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists InboundSamlSsoProfiles for a customer.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
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"). -
:filter
(type:String.t
) - A Common Expression Language expression to filter the results. The only supported filter is filtering by customer. For example:customer=="customers/C0123abc"
. Omitting the filter or specifying a filter ofcustomer=="customers/my_customer"
will return the profiles for the customer that the caller (authenticated user) belongs to. -
:pageSize
(type:integer()
) - The maximum number of InboundSamlSsoProfiles to return. The service may return fewer than this value. If omitted (or defaulted to zero) the server will use a sensible default. This default may change over time. The maximum allowed value is 100. Requests with page_size greater than that will be silently interpreted as having this maximum value. -
:pageToken
(type:String.t
) - A page token, received from a previousListInboundSamlSsoProfiles
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListInboundSamlSsoProfiles
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ListInboundSamlSsoProfilesResponse{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_saml_sso_profiles_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_saml_sso_profiles_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates an InboundSamlSsoProfile.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. Resource name of the SAML SSO profile. -
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"). -
:updateMask
(type:String.t
) - Required. The list of fields to be updated. -
:body
(type:GoogleApi.CloudIdentity.V1.Model.InboundSamlSsoProfile.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure