Description
Delete an LDAP group synchronization in the Segura™ platform. The platform performs a soft delete: it removes the synchronization and clears the records that bind it to its roles, departments, profiles, and users.
Prerequisites
- An application with the Users authorization granted by the administrator in A2A, and its resource permission set to Read and write. For more information, access How to manage authorizations in A2A.
- A valid OAuth 2.0 access token. For more information, access How to authenticate an application in A2A.
- The current
ETagof the synchronization, returned by GET | List an LDAP group sync by [id].
The users and roles the synchronization already created stay in the platform. Deleting the synchronization stops future runs, it does not revoke the accesses granted by earlier runs. Review those accesses separately.
Request
DELETE /api/v2/iam/ldap-group-syncs/[id]
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
id |
int | Yes | Unique identification code of the synchronization. |
Headers
| Header | Required | Description |
|---|---|---|
If-Match |
Yes | The ETag of the synchronization as it was last read. The platform rejects the request when the stored version differs, and the synchronization is preserved. |
Example request DELETE {{url}}/api/v2/iam/ldap-group-syncs/501
Response
HTTP/1.1 204 No Content
The response carries no body.
The delete is not permanent. A later GET | List an LDAP group sync by [id] for the same identification code returns 200 OK with active set to false, not 404. The platform has no separate deleted state.
Errors
| HTTP code | Message | Possible cause | Solution |
|---|---|---|---|
403 |
api.permission.denied |
The application lacks permission for this resource. | Ask the administrator to check the application's Users authorization in A2A. |
404 |
api.resource.not_found |
No synchronization exists with the identification code sent. | Check the id and resend the request. |
412 |
api.precondition.failed |
The If-Match value does not match the stored version. The synchronization is preserved. |
Read the resource again, confirm you still want to delete it, and resend the request with the new ETag. |
428 |
api.precondition.required |
The If-Match header is missing. |
Read the resource, then resend the request with its ETag in If-Match. |
429 |
rate_limit_exceeded |
The application exceeded its request quota. | Wait for the period in the Retry-After header and resend the request. |
Authentication errors
| Message | Possible cause | Solution |
|---|---|---|
Client authentication failed. |
Application authentication failure with the Segura server. | Check the authentication parameters (Access Token URL, Client ID, and Client secret) and request a new access token. |
Invalid signature |
Failure in recognizing the client application URL. | Check the URL of the client application and resend the request. |
No route matched with those values. |
Missing authorization header in the API request. | Request a new access token. |
Request timed out. |
The request exceeded the timeout limit. | Check the connectivity between the source of the request and the Segura server. |