This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
Ctrlk
HomeDocumentationRessources
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Facebook Sign In

Get sign in with Facebook settings

get
/api/{tenantId}/admin/socialSignIn/facebook

Returns the Facebook OAuth application credentials stored in server/facebook.yml.

Authorization

Requires tenant.configuration.connector.social:read scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
200

Settings returned.

Sign in with Facebook settings.

appIdstringRequired

AppId of the associated Facebook application.

hasAppSecretbooleanRequired

Whether an AppSecret is currently configured. The secret itself is never returned.

get/api/{tenantId}/admin/socialSignIn/facebook
GET /api/{tenantId}/admin/socialSignIn/facebook HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "appId": "text",
  "hasAppSecret": true
}

Configure sign in with Facebook

put
/api/{tenantId}/admin/socialSignIn/facebook

Creates or replaces the Facebook OAuth application credentials.

Authorization

Requires tenant.configuration.connector.social:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Body

Request body to configure sign in with Facebook.

appIdstring · min: 1Required

AppId of the associated Facebook application.

appSecretstring · nullableOptional

AppSecret of the associated Facebook application. Omit or leave empty to keep the currently configured secret unchanged; required the first time sign in with Facebook is configured.

Responses
200

Settings updated.

Sign in with Facebook settings.

appIdstringRequired

AppId of the associated Facebook application.

hasAppSecretbooleanRequired

Whether an AppSecret is currently configured. The secret itself is never returned.

put/api/{tenantId}/admin/socialSignIn/facebook
PUT /api/{tenantId}/admin/socialSignIn/facebook HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "appId": "text",
  "appSecret": null
}
{
  "appId": "text",
  "hasAppSecret": true
}

Delete sign in with Facebook settings

delete
/api/{tenantId}/admin/socialSignIn/facebook

Removes the Facebook OAuth application credentials stored in server/facebook.yml, disabling sign in with Facebook for the tenant. This bypasses the AppId/AppSecret validation enforced on PUT, since a delete does not require a valid configuration.

Authorization

Requires tenant.configuration.connector.social:write scope.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Responses
204

Configuration deleted.

No content
delete/api/{tenantId}/admin/socialSignIn/facebook
DELETE /api/{tenantId}/admin/socialSignIn/facebook HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

Configuration deleted.

No content

Last updated