Get a login option

GET /api/login_options/{login_option_id}

Get a login option

Get a login option configuration by ID. This returns settings for one external authentication integration such as OIDC, LDAP, SAML 2.0, or CAS. Required IAM Permission: Action iam:GetLoginOption, Resource arn:api7:iam:organization/*

Parameters

• login_option_id (path, string, required): Login option ID.

Responses

• 200: Successfully retrieved or modified the login option.
• allOf variant 1
• value (object, optional): The specific resource.
• allOf variant 2
• value (object, optional):
• allOf variant 1
• value.id (string, optional): The object ID.
• value.created_at (integer, optional): The object created timestamp.
• value.updated_at (integer, optional): The object updated timestamp.
• value.name (string, optional): Name of the login option.
• value.logo (string, optional): The base64-encoded logo image.
• value.disable (boolean, optional): If true, disable the login option.
• value.role_mapping (array, optional): A list of role mappings defining operations and conditions under which roles are applied.
• value.role_mapping[].role_id (string, required): Unique identifier for the role.
• value.role_mapping[].role_attribute_key (string, required): The key used to identify the role attribute.
• value.role_mapping[].operation (string, required): The operation to apply on the role attribute.
• value.role_mapping[].role_attribute_value (string, required): The value expected for the role attribute based on the operation.
• value.boundary_mapping (array, optional): A list of boundary mappings defining operations and conditions under which boundaries are applied.
• value.boundary_mapping[].permission_policy_id (string, required): Unique identifier for the boundary permission policy.
• value.boundary_mapping[].attribute_key (string, required): The Name of the boundary permission policy attribute.
• value.boundary_mapping[].operation (string, required): The operation to apply on the role attribute.
• value.boundary_mapping[].attribute_value (string, required): The value expected for the boundary permission policy attribute based on the operation.
• allOf variant 2
• oneOf variant 1: OIDC
• value.provider_type (string, optional): The login option type.
• value.oidc_config (object, optional): OIDC configuration.
• value.oidc_config.client_id (string, required): The client ID of the OIDC provider.
• value.oidc_config.client_secret (string, optional): The client secret of the OIDC provider.
• value.oidc_config.issuer (string, required): The issuer URL of the OIDC provider.
• value.oidc_config.request_scopes (array, required): The request scopes of the OIDC provider.
• value.oidc_config.ssl_verify (boolean, optional): If true, verify the SSL certificate of the OIDC provider.
• value.oidc_config.callback_url (string, optional): The root URL for the OIDC provider used to generate the callback URL.
• value.oidc_config.logout_url (string, optional): The logout URL of the OIDC provider.
• value.oidc_config.attributes (object, optional): The attributes used to map the user information to API7 Enterprise.
• oneOf variant 2: SAML
• value.provider_type (string, optional): The login option type.
• value.saml_config (object, optional): SAML configuration.
• value.saml_config.idp_metadata_url (string, required): The IdP metadata URL of the SAML provider.
• value.saml_config.sp_root_url (string, required): The SP root URL of the SAML provider.
• value.saml_config.sp_acs_url (string, optional): The SP ACS URL of the SAML provider.
• value.saml_config.sp_slo_url (string, optional): The SP SLO URL of the SAML provider.
• value.saml_config.sp_metadata_url (string, optional): The SP metadata URL of the SAML provider.
• value.saml_config.sign_request (boolean, optional): Whether to sign the request of the SAML provider.
• value.saml_config.certificate (string, optional): The certificate of the SAML provider.
• value.saml_config.entity_id (string, optional): The entity ID of the SAML provider.
• value.saml_config.attributes (object, optional): The attributes used to map the user information to API7 Enterprise.
• oneOf variant 3: LDAP
• value.provider_type (string, optional): The login option type.
• value.ldap_config (object, optional): LDAP configuration.
• value.ldap_config.host (string, required): The host domain of the LDAP server.
• value.ldap_config.port (string, required): The port ID of the LDAP server.
• value.ldap_config.base_dn (string, required): The base DN of the LDAP server.
• value.ldap_config.bind_dn (string, required): Search user bind DN.
• value.ldap_config.bind_password (string, optional): Search user bind password.
• value.ldap_config.identifier (string, required): The identifier of the LDAP server. Together with the username, it forms the full DN.
• value.ldap_config.attributes (object, optional): The attributes used to map the user information to API7 Enterprise.
• value.ldap_config.timeout (integer, optional): Timeout in seconds.
• value.ldap_config.use_ssl (boolean, optional): Set it to true if the LDAP server uses an encrypted TLS connection.
• value.ldap_config.ssl_verify (boolean, optional): Set it to false if you want to skip SSL certificate validation.
• value.ldap_config.root_ca_cert (string, optional): Set the data of your root CA certificate.
• value.ldap_config.client_cert (string, optional): The client certificate.
• value.ldap_config.client_key (string, optional): The client private key.
• oneOf variant 4: Built-in
• value.provider_type (string, optional): The login option type.
• value.builtin_config (object, optional): Built-in configuration.
• value.builtin_config.login_with_email (boolean, optional): If true, enable email login.
• 400: Invalid arguments. Error details will be provided in the response.

cURL

curl -X GET '$API_BASE_URL/api/login_options/{login_option_id}'