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.

Google Sign In

Get sign in with Google settings

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

Returns the sign-in fields of server/google.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 Google settings.

clientIdstringRequired

OAuth client ID of the Google application.

gtmIdstring · nullableOptional

Identifier of the Google Tag Manager container, in the form 'GTM-XXX'.

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

{
  "clientId": "text",
  "gtmId": null
}

Configure sign in with Google

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

Creates or replaces the Google sign-in fields. The Google Wallet issuer configuration, if any, is preserved.

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 Google.

clientIdstring · min: 1Required

OAuth client ID of the Google application.

gtmIdstring · nullableOptional

Identifier of the Google Tag Manager container, in the form 'GTM-XXX'.

Responses
200

Settings updated.

Sign in with Google settings.

clientIdstringRequired

OAuth client ID of the Google application.

gtmIdstring · nullableOptional

Identifier of the Google Tag Manager container, in the form 'GTM-XXX'.

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

{
  "clientId": "text",
  "gtmId": null
}
200

Settings updated.

{
  "clientId": "text",
  "gtmId": null
}

Delete sign in with Google settings

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

Clears the sign-in fields (clientId, gtmId) of server/google.yml, disabling sign in with Google for the tenant. This bypasses the ClientId required-field validation enforced on PUT, since a delete does not require a valid configuration.

The Google Wallet issuer configuration, if any, is preserved; the file itself is only removed when no Wallet configuration remains.

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/google
DELETE /api/{tenantId}/admin/socialSignIn/google HTTP/1.1
Host: app.neostore.cloud
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

Configuration deleted.

No content

Last updated