GET | List an LDAP group sync by [id]

Description

Access every setting of one LDAP group synchronization in the Segura™ platform. The response carries the full canonical model, the ETag needed to update or delete the resource, and the state actions currently available for it.

Prerequisites

An application with the Users authorization granted by the administrator in A2A. 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.

Request

GET /api/v2/iam/ldap-group-syncs/[id]

Path parameters

Field	Type	Required	Description
`id`	int	Yes	Unique identification code of the synchronization. Note: this value is assigned by Segura™ in [POST

Example request `GET` `{{url}}/api/v2/iam/ldap-group-syncs/501`

Response

HTTP/1.1 200 OK
ETag: "174f80fa9c3b4d2e"

Keep the ETag value. PUT | Update LDAP group sync by [id], PATCH | Partially update LDAP group sync by [id], and DELETE | Delete LDAP group sync by [id] use it in the If-Match header to detect concurrent changes.

Example response body

{
    "data": {
        "id": "501",
        "group_sync": {
            "name": "Infrastructure operators",
            "active": true,
            "server": { "id": "10" },
            "user_group": { "id": "7" },
            "synchronization_enabled": true,
            "overwrite_user_accesses": false,
            "force_roles": true,
            "automatic_sync": false,
            "dn": "OU=Operators,DC=example,DC=com",
            "ad_username_attribute": "sAMAccountName",
            "ad_name_attribute": "displayname",
            "department": null,
            "ad_query": "(&(objectClass=group)(cn=ops-*))",
            "roles": [{ "id": 1 }, { "id": 3 }]
        },
        "domum": {
            "enabled": true,
            "type": "limited_users",
            "vendor": { "id": 22 }
        }
    },
    "meta": {
        "links": { "self": "/api/v2/iam/ldap-group-syncs/501" },
        "actions": {
            "sync": "/api/v2/iam/ldap-group-syncs/501/sync",
            "deactivate": "/api/v2/iam/ldap-group-syncs/501/deactivate"
        }
    }
}

Response body fields

Field	Type	Description
`data`	object	The synchronization.
`meta`	object	Links and the actions available for the resource in its current state.

`data`

Field	Type	Description
→`id`	string	Unique identification code of the synchronization.
→`group_sync`	object	The synchronization settings.
→`domum`	object	The Domum settings. Returned only when the `cote` license module is active.

`data.group_sync`

Field	Type	Description
→→`name`	string	Name of the synchronization.
→→`active`	boolean	Indicates whether the synchronization is active.
→→`server`	object	The LDAP server, as `{ "id": <string> }`.
→→`user_group`	object	The user group, as `{ "id": <string> }`.
→→`synchronization_enabled`	boolean	Indicates whether the synchronization runs.
→→`overwrite_user_accesses`	boolean	Indicates whether the synchronization overwrites accesses already assigned to a user.
→→`force_roles`	boolean	Indicates whether the synchronization removes roles the Active Directory group no longer grants.
→→`automatic_sync`	boolean	Indicates whether the platform runs the synchronization on its own schedule.
→→`dn`	string	Base distinguished name searched in the directory.
→→`ad_username_attribute`	string	Active Directory attribute read as the username.
→→`ad_name_attribute`	string	Active Directory attribute read as the full name. Returns `null` when no supported attribute is stored.
→→`department`	object	The department assigned to the synchronized users. Returns `null` when not set.
→→`ad_query`	string	LDAP filter that selects the groups to synchronize.
→→`roles`	array of objects	The ACL roles assigned, each as `{ "id": <int> }`.

`data.domum`

Field	Type	Description
→→`enabled`	boolean	Indicates whether the synchronized users receive Domum access.
→→`type`	string	Access profile granted in Domum. Returns `full_users` or `limited_users`.
→→`vendor`	object	The vendor or internal group, as `{ "id": <int> }`.

`meta.actions`

The actions reflect the current state of the resource. An active synchronization offers sync and deactivate; an inactive one offers sync and activate.

Field	Type	Description
→→`sync`	string	Path of [POST
→→`activate`	string	Path of [POST
→→`deactivate`	string	Path of [POST

Info

A synchronization deleted with DELETE | Delete LDAP group sync by [id] still answers this request. It returns 200 OK with active set to false, not 404.

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