View Source GoogleApi.CloudIdentity.V1.Api.InboundSsoAssignments (google_api_cloud_identity v0.30.0)
API calls for all endpoints tagged InboundSsoAssignments
.
Summary
Functions
Creates an InboundSsoAssignment for users and devices in a Customer
under a given Group
or OrgUnit
.
Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has sso_mode
== SSO_OFF
.
Gets an InboundSsoAssignment.
Lists the InboundSsoAssignments for a Customer
.
Updates an InboundSsoAssignment. The body of this request is the inbound_sso_assignment
field and the update_mask
is relative to that. For example: a PATCH to /v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank
with a body of { "rank": 1 }
moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.
Functions
cloudidentity_inbound_sso_assignments_create(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_sso_assignments_create( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.Operation.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Creates an InboundSsoAssignment for users and devices in a Customer
under a given Group
or OrgUnit
.
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.InboundSsoAssignment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_sso_assignments_delete(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_sso_assignments_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 InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has sso_mode
== SSO_OFF
.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the InboundSsoAssignment to delete. Format:inboundSsoAssignments/{assignment}
-
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_sso_assignments_get(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_sso_assignments_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.InboundSsoAssignment.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets an InboundSsoAssignment.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. The resource name of the InboundSsoAssignment to fetch. Format:inboundSsoAssignments/{assignment}
-
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.InboundSsoAssignment{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_sso_assignments_list(connection, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_sso_assignments_list( Tesla.Env.client(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.ListInboundSsoAssignmentsResponse.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Lists the InboundSsoAssignments 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 CEL 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 assignments for the customer that the caller (authenticated user) belongs to. -
:pageSize
(type:integer()
) - The maximum number of assignments 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, though requests with page_size greater than that will be silently interpreted as having this maximum value. This may increase in the futue. -
:pageToken
(type:String.t
) - A page token, received from a previousListInboundSsoAssignments
call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListInboundSsoAssignments
must match the call that provided the page token.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.ListInboundSsoAssignmentsResponse{}}
on success -
{:error, info}
on failure
cloudidentity_inbound_sso_assignments_patch(connection, name, optional_params \\ [], opts \\ [])
View Source@spec cloudidentity_inbound_sso_assignments_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 InboundSsoAssignment. The body of this request is the inbound_sso_assignment
field and the update_mask
is relative to that. For example: a PATCH to /v1/inboundSsoAssignments/0abcdefg1234567&update_mask=rank
with a body of { "rank": 1 }
moves that (presumably group-targeted) SSO assignment to the highest priority and shifts any other group-targeted assignments down in priority.
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Output only. Resource name of the Inbound SSO Assignment. -
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.InboundSsoAssignment.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.Operation{}}
on success -
{:error, info}
on failure