# Cloud Identity API . inboundSsoAssignments

## Instance Methods

Close httplib2 connections.

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`.

Retrieves the next page of results.

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.

### Method Details

`close()`

    Close httplib2 connections.

`create(body=None, x__xgafv=None)`

    Creates an InboundSsoAssignment for users and devices in a `Customer` under a given `Group` or `OrgUnit`.

    Args:
      body: object, The request body.
        The object takes the form of:

    { # Targets with "set" SSO assignments and their respective assignments.
      "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
      "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
      "oidcSsoInfo": { # Details that are applicable when `sso_mode` is set to `OIDC_SSO`. # OpenID Connect SSO details. Must be set if and only if `sso_mode` is set to `OIDC_SSO`.
        "inboundOidcSsoProfile": "A String", # Required. Name of the `InboundOidcSsoProfile` to use. Must be of the form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`.
      },
      "rank": 42, # Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set.
      "samlSsoInfo": { # Details that are applicable when `sso_mode` == `SAML_SSO`. # SAML SSO details. Must be set if and only if `sso_mode` is set to `SAML_SSO`.
        "inboundSamlSsoProfile": "A String", # Required. Name of the `InboundSamlSsoProfile` to use. Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`.
      },
      "signInBehavior": { # Controls sign-in behavior. # Assertions about users assigned to an IdP will always be accepted from that IdP. This controls whether/when Google should redirect a user to the IdP. Unset (defaults) is the recommended configuration.
        "redirectCondition": "A String", # When to redirect sign-ins to the IdP.
      },
      "ssoMode": "A String", # Inbound SSO behavior.
      "targetGroup": "A String", # Immutable. Must be of the form `groups/{group}`.
      "targetOrgUnit": "A String", # Immutable. Must be of the form `orgUnits/{org_unit}`.
    }

      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`delete(name, x__xgafv=None)`

    Deletes an InboundSsoAssignment. To disable SSO, Create (or Update) an assignment that has `sso_mode` == `SSO_OFF`.

    Args:
      name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to delete. Format: `inboundSsoAssignments/{assignment}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }

`get(name, x__xgafv=None)`

    Gets an InboundSsoAssignment.

    Args:
      name: string, Required. The [resource name](https://cloud.google.com/apis/design/resource_names) of the InboundSsoAssignment to fetch. Format: `inboundSsoAssignments/{assignment}` (required)
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Targets with "set" SSO assignments and their respective assignments.
      "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
      "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
      "oidcSsoInfo": { # Details that are applicable when `sso_mode` is set to `OIDC_SSO`. # OpenID Connect SSO details. Must be set if and only if `sso_mode` is set to `OIDC_SSO`.
        "inboundOidcSsoProfile": "A String", # Required. Name of the `InboundOidcSsoProfile` to use. Must be of the form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`.
      },
      "rank": 42, # Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set.
      "samlSsoInfo": { # Details that are applicable when `sso_mode` == `SAML_SSO`. # SAML SSO details. Must be set if and only if `sso_mode` is set to `SAML_SSO`.
        "inboundSamlSsoProfile": "A String", # Required. Name of the `InboundSamlSsoProfile` to use. Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`.
      },
      "signInBehavior": { # Controls sign-in behavior. # Assertions about users assigned to an IdP will always be accepted from that IdP. This controls whether/when Google should redirect a user to the IdP. Unset (defaults) is the recommended configuration.
        "redirectCondition": "A String", # When to redirect sign-ins to the IdP.
      },
      "ssoMode": "A String", # Inbound SSO behavior.
      "targetGroup": "A String", # Immutable. Must be of the form `groups/{group}`.
      "targetOrgUnit": "A String", # Immutable. Must be of the form `orgUnits/{org_unit}`.
    }

`list(filter=None, pageSize=None, pageToken=None, x__xgafv=None)`

    Lists the InboundSsoAssignments for a `Customer`.

    Args:
      filter: string, 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 of `customer==customers/my_customer` will return the assignments for the customer that the caller (authenticated user) belongs to.
      pageSize: 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: string, A page token, received from a previous `ListInboundSsoAssignments` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListInboundSsoAssignments` must match the call that provided the page token.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # Response of the InboundSsoAssignmentsService.ListInboundSsoAssignments method.
      "inboundSsoAssignments": [ # The assignments.
        { # Targets with "set" SSO assignments and their respective assignments.
          "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
          "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
          "oidcSsoInfo": { # Details that are applicable when `sso_mode` is set to `OIDC_SSO`. # OpenID Connect SSO details. Must be set if and only if `sso_mode` is set to `OIDC_SSO`.
            "inboundOidcSsoProfile": "A String", # Required. Name of the `InboundOidcSsoProfile` to use. Must be of the form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`.
          },
          "rank": 42, # Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set.
          "samlSsoInfo": { # Details that are applicable when `sso_mode` == `SAML_SSO`. # SAML SSO details. Must be set if and only if `sso_mode` is set to `SAML_SSO`.
            "inboundSamlSsoProfile": "A String", # Required. Name of the `InboundSamlSsoProfile` to use. Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`.
          },
          "signInBehavior": { # Controls sign-in behavior. # Assertions about users assigned to an IdP will always be accepted from that IdP. This controls whether/when Google should redirect a user to the IdP. Unset (defaults) is the recommended configuration.
            "redirectCondition": "A String", # When to redirect sign-ins to the IdP.
          },
          "ssoMode": "A String", # Inbound SSO behavior.
          "targetGroup": "A String", # Immutable. Must be of the form `groups/{group}`.
          "targetOrgUnit": "A String", # Immutable. Must be of the form `orgUnits/{org_unit}`.
        },
      ],
      "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
    }

`list_next()`

    Retrieves the next page of results.

            Args:
              previous_request: The request for the previous page. (required)
              previous_response: The response from the request for the previous page. (required)

            Returns:
              A request object that you can call 'execute()' on to request the next
              page. Returns None if there are no more items in the collection.

`patch(name, body=None, updateMask=None, x__xgafv=None)`

    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.

    Args:
      name: string, Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment. (required)
      body: object, The request body.
        The object takes the form of:

    { # Targets with "set" SSO assignments and their respective assignments.
      "customer": "A String", # Immutable. The customer. For example: `customers/C0123abc`.
      "name": "A String", # Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the Inbound SSO Assignment.
      "oidcSsoInfo": { # Details that are applicable when `sso_mode` is set to `OIDC_SSO`. # OpenID Connect SSO details. Must be set if and only if `sso_mode` is set to `OIDC_SSO`.
        "inboundOidcSsoProfile": "A String", # Required. Name of the `InboundOidcSsoProfile` to use. Must be of the form `inboundOidcSsoProfiles/{inbound_oidc_sso_profile}`.
      },
      "rank": 42, # Must be zero (which is the default value so it can be omitted) for assignments with `target_org_unit` set and must be greater-than-or-equal-to one for assignments with `target_group` set.
      "samlSsoInfo": { # Details that are applicable when `sso_mode` == `SAML_SSO`. # SAML SSO details. Must be set if and only if `sso_mode` is set to `SAML_SSO`.
        "inboundSamlSsoProfile": "A String", # Required. Name of the `InboundSamlSsoProfile` to use. Must be of the form `inboundSamlSsoProfiles/{inbound_saml_sso_profile}`.
      },
      "signInBehavior": { # Controls sign-in behavior. # Assertions about users assigned to an IdP will always be accepted from that IdP. This controls whether/when Google should redirect a user to the IdP. Unset (defaults) is the recommended configuration.
        "redirectCondition": "A String", # When to redirect sign-ins to the IdP.
      },
      "ssoMode": "A String", # Inbound SSO behavior.
      "targetGroup": "A String", # Immutable. Must be of the form `groups/{group}`.
      "targetOrgUnit": "A String", # Immutable. Must be of the form `orgUnits/{org_unit}`.
    }

      updateMask: string, Required. The list of fields to be updated.
      x__xgafv: string, V1 error format.
        Allowed values
          1 - v1 error format
          2 - v2 error format

    Returns:
      An object of the form:

        { # This resource represents a long-running operation that is the result of a network API call.
      "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
      "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
        "code": 42, # The status code, which should be an enum value of google.rpc.Code.
        "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
          {
            "a_key": "", # Properties of the object. Contains field @type with type URL.
          },
        ],
        "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
      },
      "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
      "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
      "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    }