> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.
# Get OAuth Settings
> List all the OAuth services. enabled in the workspace.
### Changelog
| Version | Description |
| ---------------- | ------------|
|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 |
## OpenAPI
````json GET /api/v1/settings.oauth
{
"openapi": "3.0.0",
"info": {
"version": "1.0.0",
"title": "Settings"
},
"servers": [
{
"url": "https://apiexplorer.support.rocket.chat"
}
],
"paths": {
"/api/v1/settings.oauth": {
"get": {
"summary": "Get OAuth Settings",
"operationId": "get-api-v1-settings.oauth",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"services": {
"type": "array",
"items": {
"type": "object",
"properties": {
"_id": {
"type": "string"
},
"name": {
"type": "string"
},
"clientId": {
"type": "string"
},
"buttonLabelText": {
"type": "string"
},
"buttonColor": {
"type": "string"
},
"buttonLabelColor": {
"type": "string"
},
"custom": {
"type": "boolean"
},
"service": {
"type": "string"
},
"serverURL": {
"type": "string"
},
"tokenPath": {
"type": "string"
},
"identityPath": {
"type": "string"
},
"authorizePath": {
"type": "string"
},
"scope": {
"type": "string"
},
"loginStyle": {
"type": "string"
},
"tokenSentVia": {
"type": "string"
},
"identityTokenSentVia": {
"type": "string"
},
"usernameField": {
"type": "string"
},
"mergeUsers": {
"type": "boolean"
}
}
}
},
"success": {
"type": "boolean"
}
}
},
"examples": {
"Success Example": {
"value": {
"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"
}
],
"success": "true"
}
}
}
}
}
}
},
"tags": [
"Settings"
],
"description": "List all the OAuth services. enabled in the workspace.\n### Changelog\n| Version | Description |\n| ---------------- | ------------|\n|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`) |\n|0.63.0 | Added |",
"parameters": []
}
}
}
}
````