Sync User Federation

Sync User Federation

This API is used to retrieve user-federation configuration.

Request
URI
POST
https://{api_host}/tcsa/api/auth-management/v1/components/{id}/sync
COPY
Path Parameters
string
id
Required

Unique id of user-federation configuration.

Query Parameters
string
action
Optional

action

Possible values are : triggerFullSync, triggerChangedUsersSync,
Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns SyncResponse of type(s) application/json 
{
    "ignored": false,
    "added": 0,
    "updated": 0,
    "removed": 0,
    "failed": 0,
    "status": "0 imported users, 0 updated users"
}
boolean
ignored
Optional

Indicates if any users were ignored during synchronization.

integer
added
Optional

The number of new users added during synchronization.

integer
updated
Optional

The number of users updated during synchronization.

integer
removed
Optional

The number of users removed during synchronization.

integer
failed
Optional

The number of users that failed to synchronize.

string
status
Optional

A status message indicating the result of the synchronization.


500

Unknown error

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/tcsa/api/auth-management/v1/components/{id}/sync
On This Page
User Federation Operations
POST
Configure User Federation
Deprecated
GET
Get All User Federation
Deprecated
GET
Get User Federation
Deprecated
DELETE
Delete User Federation
Deprecated
PUT
Update User Federation
Deprecated
PATCH
Patch User Federation
Deprecated
POST
Test Ldap Connection
GET
Get All User Federation Configuration
POST
Create User Federation Configuration
GET
Get User Federation Configuration
DELETE
Delete User Federation Configuration
PUT
Update User Federation Configuration
POST
Sync User Federation
POST
Remove Imported Users
POST
Unlink Users