REST Resource: projects.inboundSamlConfigs

Stay organized with collections Save and categorize content based on your preferences.

Resource: InboundSamlConfig

A pair of SAML RP-IDP configurations when the project acts as the relying party.

JSON representation
{
  "name": string,
  "idpConfig": {
    object (IdpConfig)
  },
  "spConfig": {
    object (SpConfig)
  },
  "displayName": string,
  "enabled": boolean
}
Fields
name

string

The name of the InboundSamlConfig resource, for example: 'projects/my-awesome-project/inboundSamlConfigs/my-config-id'. Ignored during create requests.

idpConfig

object (IdpConfig)

The SAML IdP (Identity Provider) configuration when the project acts as the relying party.

spConfig

object (SpConfig)

The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider.

displayName

string

The config's display name set by developers.

enabled

boolean

True if allows the user to sign in with the provider.

IdpConfig

The SAML IdP (Identity Provider) configuration when the project acts as the relying party.

JSON representation
{
  "idpEntityId": string,
  "ssoUrl": string,
  "idpCertificates": [
    {
      object (IdpCertificate)
    }
  ],
  "signRequest": boolean
}
Fields
idpEntityId

string

Unique identifier for all SAML entities.

ssoUrl

string

URL to send Authentication request to.

idpCertificates[]

object (IdpCertificate)

IDP's public keys for verifying signature in the assertions.

signRequest

boolean

Indicates if outbounding SAMLRequest should be signed.

IdpCertificate

The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP.

JSON representation
{
  "x509Certificate": string
}
Fields
x509Certificate

string

The x509 certificate

SpConfig

The SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider.

JSON representation
{
  "spEntityId": string,
  "callbackUri": string,
  "spCertificates": [
    {
      object (SpCertificate)
    }
  ]
}
Fields
spEntityId

string

Unique identifier for all SAML entities.

callbackUri

string

Callback URI where responses from IDP are handled.

spCertificates[]

object (SpCertificate)

Output only. Public certificates generated by the server to verify the signature in SAMLRequest in the SP-initiated flow.

SpCertificate

The SP's certificate data for IDP to verify the SAMLRequest generated by the SP.

JSON representation
{
  "x509Certificate": string,
  "expiresAt": string
}
Fields
x509Certificate

string

Self-signed public certificate.

expiresAt

string (Timestamp format)

Timestamp of the cert expiration instance.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

Methods

create

Create an inbound SAML configuration for an Identity Toolkit project.

delete

Delete an inbound SAML configuration for an Identity Toolkit project.

get

Retrieve an inbound SAML configuration for an Identity Toolkit project.

list

List all inbound SAML configurations for an Identity Toolkit project.

patch

Update an inbound SAML configuration for an Identity Toolkit project.