Lists the login service configurations available to login clients. This public endpoint does not require authentication.
For SAML, the response contains the stored service configuration but excludes the secret object. Starting in 8.8.0, hideButtonOnMobile follows Accounts_OAuth_Use_Modern_Flow. When this setting is enabled, mobile and desktop apps can open SAML authentication in the system browser and receive the credential through the rocketchat://auth link.
Changelog
| Version | Description |
|---|---|
| 8.8.0 | Updated hideButtonOnMobile for the SAML system-browser login flow. |
| 0.64.0 | Renamed field appId to clientId and added flag custom to indicate whether the OAuth service is customized and fix id inconsistence (set all cases to _id) |
| 0.63.0 | Added |
OK
{
"services": [
{
"_id": "iJeY7x4wxnh2p3pLr",
"name": "facebook",
"clientId": "test",
"buttonLabelText": "test",
"buttonColor": "#13679A",
"buttonLabelColor": "#FFFFFF",
"custom": false
},
{
"_id": "iJeY7x4wxnh2p3pLr",
"name": "twitter",
"clientId": "test",
"buttonLabelText": "",
"buttonColor": "",
"buttonLabelColor": "",
"custom": false
},
{
"_id": "5RQ4SBL3NuZKsqxaF",
"service": "test",
"clientId": "test",
"custom": true,
"serverURL": "/test/test",
"tokenPath": "/oauth/token",
"identityPath": "/me",
"authorizePath": "/oauth/authorize",
"scope": "openid",
"buttonLabelText": "test",
"buttonLabelColor": "#FFFFFF",
"loginStyle": "popup",
"buttonColor": "#13679A",
"tokenSentVia": "payload",
"identityTokenSentVia": "default",
"usernameField": "dfsgdfgdfgdfgsd",
"mergeUsers": true
},
{
"_id": "8kEcbW7Yz3zJnHgqL",
"service": "saml",
"buttonLabelText": "Sign in with SAML",
"buttonColor": "#13679A",
"buttonLabelColor": "#FFFFFF",
"clientConfig": {
"provider": "my-saml-provider"
},
"entryPoint": "https://idp.example.com/sso/saml",
"idpSLORedirectURL": "https://idp.example.com/slo/saml",
"issuer": "https://chat.example.com/_saml/metadata/my-saml-provider",
"userDataFieldMap": "{\"username\":\"username\",\"email\":\"email\",\"name\":\"cn\"}",
"hideButtonOnMobile": true
}
],
"success": true
}Whether mobile clients should hide the service's login button. For SAML, this is true when Accounts_OAuth_Use_Modern_Flow is enabled and false otherwise.
Client configuration for the login service.
The configured SAML provider name.
The URL where Rocket.Chat sends SAML authentication requests.
The identity provider URL where Rocket.Chat sends SAML logout requests.
The SAML service provider issuer.
A JSON string that maps SAML user fields to Rocket.Chat user fields.