Delete an Idp group mapping.

DELETE /api/configuration/authentication/consumer-sso-idp-groups/{id}

• Products: Operator (FOH)
• Features: Front of House Generic Access (FOHGENERIC)

Overview

Removes one consumer SSO IdP group mapping — the record that ties a group name from your external identity provider to a Gladstone price level and site. Once it is gone, that IdP group no longer resolves to a price level.

The mapping is permanently deleted. It carries no active or deleted flag, so there is no deactivate alternative — to reinstate a mapping you create it again through Update IdP group mappings list.

The only check made is that the mapping exists. There is no dependency check, so the call never refuses on the grounds that the mapping is in use.

A successful call returns 204 No Content with an empty body, and the next read of the mapping list reflects the change. Repeating the call returns 404 — deleting an id twice is an error, not a silent no-op.

Prefer this endpoint over the bulk PUT when you want to remove a single mapping: the bulk call replaces the whole list and deletes every mapping you leave out of it.

Endpoint

DELETE {base_url}/api/configuration/authentication/consumer-sso-idp-groups/{id}

{base_url} is the environment URL issued to your integration. See Authenticating with Gladstone APIs.

Path parameters

Sample request

curl -X DELETE '{base_url}/api/configuration/authentication/consumer-sso-idp-groups/{id}' \
  -H 'Authorization: Bearer {accessToken}' \
  -H 'X-Use-SSO: true'

Errors

This page as markdown · All pages · llms.txt