SAMLIdentityProvider
SAMLIdentityProvider
is
a datatype for an SAML identity provider.
Table: SAMLIdentityProvider
Parameter | Type | Required | Default | Stability | Description |
---|---|---|---|---|---|
Some arguments may be required, as indicated in the Required column. For some fields, this column indicates that a result will always be returned for this column. | |||||
Table last updated: Mar 17, 2025 | |||||
adminAttribute | string | Long-Term | This field is for internal use only by LogScale. | ||
adminAttributeMatch | string | Long-Term | This field is for internal use only by LogScale. | ||
alternativeIdpCertificateInBase64 | string | Long-Term | An alternative IdP certificate using Base64 encoding. | ||
authenticationMethod | AuthenticationMethodAuth | yes | Long-Term | The authentication method used. See AuthenticationMethodAuth . | |
debug | boolean | yes | Long-Term | Whether debugging is enabled. | |
defaultIdp | boolean | yes | Long-Term | Whether the identity service provider is the default. | |
domains | [string] | yes | Long-Term | The domains of the SAML identity provider. | |
groupMembershipAttribute | string | Long-Term | The saml attribute used to extract groups from when receiving the SamlResponse from the IDP. The groups from the response will be used to synchronize the membership of groups in LogScale. The group name and external provider name of the group are matched in LogScale. | ||
humioManaged | boolean | yes | Long-Term | Where SAML authentication is managed by LogScale. | |
id | string | yes | Long-Term | The unique identifier for the SAML installation. | |
idpCertificateInBase64 | string | yes | Long-Term | The identity provider's certificated converted to Base64. | |
idpEntityId | string | yes | Long-Term | The unique identifier of the IDP entity. | |
lazyCreateUsers | boolean | yes | Long-Term | Whether to wait to create users until necessary. | |
name | string | yes | Long-Term | The name of the SAML identity provider. | |
signOnUrl | string | yes | Long-Term | The URL of where the sign on page is located. | |
userAttribute | string | Long-Term | This is the saml attribute from which to extract username when receiving the SamlResponse from the IDP. If not specified, the default saml:NameID will be used. |