# REST Resource: inboundSamlSsoProfiles

## Resource: InboundSamlSsoProfile

A [SAML 2.0](https://www.oasis-open.org/standards#samlv2.0) federation between a Google enterprise customer and a SAML identity provider.

| JSON representation |
|---|
| ``` { "name": string, "customer": string, "displayName": string, "idpConfig": { object (`https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#SamlIdpConfig`) }, "spConfig": { object (`https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#SamlSpConfig`) } } ``` |

| Fields ||
|---|---|
| `name` | `string` Output only. [Resource name](https://cloud.google.com/apis/design/resource_names) of the SAML SSO profile. |
| `customer` | `string` Immutable. The customer. For example: `customers/C0123abc`. |
| `displayName` | `string` Human-readable name of the SAML SSO profile. |
| `idpConfig` | ``object (`https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#SamlIdpConfig`)`` SAML identity provider configuration. |
| `spConfig` | ``object (`https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#SamlSpConfig`)`` SAML service provider configuration for this SAML SSO profile. These are the service provider details provided by Google that should be configured on the corresponding identity provider. |

## SamlIdpConfig

SAML IDP (identity provider) configuration.

| JSON representation |
|---|
| ``` { "entityId": string, "singleSignOnServiceUri": string, "logoutRedirectUri": string, "changePasswordUri": string } ``` |

| Fields ||
|---|---|
| `entityId` | `string` Required. The SAML **Entity ID** of the identity provider. |
| `singleSignOnServiceUri` | `string` Required. The `SingleSignOnService` endpoint location (sign-in page URL) of the identity provider. This is the URL where the `AuthnRequest` will be sent. Must use `HTTPS`. Assumed to accept the `HTTP-Redirect` binding. |
| `logoutRedirectUri` | `string` The **Logout Redirect URL** (sign-out page URL) of the identity provider. When a user clicks the sign-out link on a Google page, they will be redirected to this URL. This is a pure redirect with no attached SAML `LogoutRequest` i.e. SAML single logout is not supported. Must use `HTTPS`. |
| `changePasswordUri` | `string` The **Change Password URL** of the identity provider. Users will be sent to this URL when changing their passwords at `myaccount.google.com`. This takes precedence over the change password URL configured at customer-level. Must use `HTTPS`. |

## SamlSpConfig

SAML SP (service provider) configuration.

| JSON representation |
|---|
| ``` { "entityId": string, "assertionConsumerServiceUri": string } ``` |

| Fields ||
|---|---|
| `entityId` | `string` Output only. The SAML **Entity ID** for this service provider. |
| `assertionConsumerServiceUri` | `string` Output only. The SAML **Assertion Consumer Service (ACS) URL** to be used for the IDP-initiated login. Assumed to accept response messages via the `HTTP-POST` binding. |

| ## Methods ||
|---|---|
| ### `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles/create` | Creates an `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#InboundSamlSsoProfile` for a customer. |
| ### `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles/delete` | Deletes an `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#InboundSamlSsoProfile`. |
| ### `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles/get` | Gets an `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#InboundSamlSsoProfile`. |
| ### `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles/list` | Lists `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#InboundSamlSsoProfile`s for a customer. |
| ### `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles/patch` | Updates an `https://docs.cloud.google.com/identity/docs/reference/rest/v1beta1/inboundSamlSsoProfiles#InboundSamlSsoProfile`. |