SamlIdentityProvider
An SamlIdentityProvider defines the information returned about an external SAML identity provider for use with user authentication or user verification.
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| acr_values | str | The space separated list of authentication context request values to request as part of the external SAML identity provider user authentication or user verification request. | [optional] |
| acs_url | str | The assertion consumer service URL provided to the external SAML identity provider. Leave empty to use default value. | [optional] |
| authentication_enabled | bool | A flag indicating if the external SAML identity provider can be used for user authentication. | [optional] |
| button_image | str | The URI of the logo to display on the login button for this external SAML identity provider. | [optional] |
| button_text | str | The unique text to display on the login button for this external SAML identity provider. | [optional] |
| create_user | bool | A flag indicating if the user should be created after authenticating to the external SAML identity provider if it doesn't exist. The user attributes specified by the userAttributeMappings attribute are used to populate the user in IDaaS. This value is used if authenticationEnabled is true. | [optional] |
| domains | str | The space separated list of domains associated with the external SAML identity provider for use with user authentication. | [optional] |
| force_authn | bool | A flag indicating if a force authentication should always be requested as part of the external SAML identity provider user authentication or user verification request. | [optional] |
| group_ids | List[str] | The UUIDs of groups that will be assigned to users created after an external SAML identity provider user authentication. An empty list means the user will be assigned to All Groups. If configured, the full set of groups must be configured. This value is used if createUser is true. | [optional] |
| group_mapping | str | The association between a specified claim returned from the external SAML identity provider and IDaaS groups. This mapping is used to associated IDaaS groups when a user is created or modified based on an external SAML identity provider user authentication or when it is modified based on an external SAML identity provider user verification. This value is used if createUser, updateUser, or updateVerificationUser is true. | [optional] |
| id | str | The UUID of the external SAML identity provider. | [optional] |
| issuer | str | The issuer, or IDP Entity ID, for the external SAML identity provider. | [optional] |
| name | str | The unique name of the external SAML identity provider. | [optional] |
| name_id_policy_format | str | The name ID policy format to request as part of the external OIDC identity provider user authentication or user verification request. | [optional] |
| organization_ids | List[str] | The UUIDs of organizations that will be assigned to users created after an external SAML identity provider user authentication. If configured, the full set of organizations must be configured. This value is used if createUser is true. | [optional] |
| require_assertion_signature | bool | A flag indicating if the SAML Assertion of the external SAML identity provider should be signed and verified. | [optional] |
| require_response_signature | bool | A flag indicating if the SAML Response of the external SAML identity provider should be signed and verified. | [optional] |
| role_mapping | str | The association between a specified claim returned from the external SAML identity provider and an IDaaS role. This mapping is used to associated an IDaaS role when a user is created or modified based on an external SAML identity provider user authentication or when it is modified based on an external SAML identity provider user verification. This value is used if createUser, updateUser, or updateVerificationUser is true. | [optional] |
| slo_endpoint | str | The single logout endpoint for the external SAML identity provider. | [optional] |
| sp_entity_id | str | The SP entity ID provided to the external SAML identity provider. | [optional] |
| sso_endpoint | str | The single signon endpoint for the external SAML identity provider. | [optional] |
| type | str | The type of the external SAML identity provider. Once created, this value cannot be updated. | [optional] |
| update_user | bool | A flag indicating if the user should be updated after authenticating to the external SAML identity provider if it exists. The user attributes specified by the userAttributeMappings attribute are used to populate the user in IDaaS. This value is used if authenticationEnabled is true. | [optional] |
| update_user_verification | bool | A flag indicating if the user should be updated after user verification to the external SAML identity provider if it exists. The user attributes specified by the userAttributeMappings attribute are used to populate the user in IDaaS. This value is used if verificationEnabled is true. | [optional] |
| user_attribute_id | str | The IDaaS user attribute ID used to find IDaaS users associated with an external SAML identity provider user authentication. This value is used if authenticationEnabled is true. | [optional] |
| user_attribute_mappings | List[SamlIdentityProviderAttributeMapping] | The association between the claims returned from the external SAML identity provider and IDaaS user attributes. These attributes are used to populate user attributes when it is created or modified based on an external SAML identity provider user authentication or when it is modified based on an external SAML identity provider user verification. If configured, the full set of mappings must be configured. This value is used if createUser, updateUser, or updateVerificationUser is true. | [optional] |
| user_auth_match_mappings | List[SamlIdentityProviderUserAuthMatchMapping] | The association between the claims returned from the external SAML identity provider and IDaaS user attributes. These attributes are used to match an existing IDaaS user based on an external SAML identity provider user authentication. If configured, the full set of mappings must be configured. This value is used if authenticationEnabled is true. | [optional] |
| user_claim | str | The external SAML identity provider claim (attribute) used to find IDaaS users associated with an external SAML identity provider user authentication. This value is used if authenticationEnabled is true. | [optional] |
| user_name_format | str | If user name parameter is set to NameID, the value of the format of this value. | [optional] |
| user_name_parameter | str | The name of the parameter to include with the SAML authentication request that will contain the value of the user's userid. Set the value to NameID to pass this value as part of the SAML Request message. | [optional] |
| user_ver_match_mappings | List[SamlIdentityProviderUserVerMatchMapping] | The association between the claims returned from the external SAML identity provider and IDaaS user attributes. These attributes are used to match an existing IDaaS user based on an external SAML identity provider user verification. If configured, the full set of mappings must be configured. This value is used if verificationEnabled is true. | [optional] |
| verification_certificate | bytearray | The verification certificate used with the external SAML identity provider. | [optional] |
| verification_certificate2 | bytearray | The verification certificate2 used with the external SAML identity provider. | [optional] |
| verification_certificate2_dn | str | The verification certificate2 DN used with the external SAML identity provider. | [optional] |
| verification_certificate2_expiry_date | datetime | The verification certificate2 expiry date used with the external SAML identity provider. | [optional] |
| verification_certificate_dn | str | The verification certificate DN used with the external SAML identity provider. | [optional] |
| verification_certificate_expiry_date | datetime | The verification certificate expiry date used with the external SAML identity provider. | [optional] |
| verification_enabled | bool | A flag indicating if the external SAML identity provider can be used for user verification. | [optional] |