Get User Federation Configuration

Get User Federation Configuration

This API is used to retrieve user-federation configuration.

Request
URI
GET
https://{api_host}/tcsa/api/auth-management/v1/components/{id}
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Ok

Returns ADComponent of type(s) application/json 
{
    "name": "string",
    "providerId": "string",
    "providerType": "string",
    "parentId": "string",
    "config": {
        "enabled": [
            "string"
        ],
        "priority": [
            "string"
        ],
        "fullSyncPeriod": [
            "string"
        ],
        "changedSyncPeriod": [
            "string"
        ],
        "cachePolicy": [
            "string"
        ],
        "evictionDay": [
            "string"
        ],
        "evictionHour": [
            "string"
        ],
        "evictionMinute": [
            "string"
        ],
        "maxLifespan": [
            "string"
        ],
        "batchSizeForSync": [
            "string"
        ],
        "editMode": [
            "string"
        ],
        "importEnabled": [
            "string"
        ],
        "syncRegistrations": [
            "string"
        ],
        "vendor": [
            "string"
        ],
        "usePasswordModifyExtendedOp": [
            "string"
        ],
        "usernameLDAPAttribute": [
            "string"
        ],
        "rdnLDAPAttribute": [
            "string"
        ],
        "uuidLDAPAttribute": [
            "string"
        ],
        "userObjectClasses": [
            "string"
        ],
        "connectionUrl": [
            "string"
        ],
        "usersDn": [
            "string"
        ],
        "authType": [
            "string"
        ],
        "startTls": [
            "string"
        ],
        "bindDn": [
            "string"
        ],
        "bindCredential": [
            "string"
        ],
        "customUserSearchFilter": [
            "string"
        ],
        "searchScope": [
            "string"
        ],
        "validatePasswordPolicy": [
            "string"
        ],
        "trustEmail": [
            "string"
        ],
        "useTruststoreSpi": [
            "string"
        ],
        "connectionPooling": [
            "string"
        ],
        "connectionPoolingAuthentication": [
            "string"
        ],
        "connectionPoolingDebug": [
            "string"
        ],
        "connectionPoolingInitSize": [
            "string"
        ],
        "connectionPoolingMaxSize": [
            "string"
        ],
        "connectionPoolingPrefSize": [
            "string"
        ],
        "connectionPoolingProtocol": [
            "string"
        ],
        "connectionPoolingTimeout": [
            "string"
        ],
        "connectionTimeout": [
            "string"
        ],
        "readTimeout": [
            "string"
        ],
        "pagination": [
            "string"
        ],
        "allowKerberosAuthentication": [
            "string"
        ],
        "serverPrincipal": [
            "string"
        ],
        "keyTab": [
            "string"
        ],
        "kerberosRealm": [
            "string"
        ],
        "debug": [
            "string"
        ],
        "useKerberosForPasswordAuthentication": [
            "string"
        ]
    }
}
string
name
Optional

The name of the component.

string
providerId
Optional

The provider ID of the component.

string
providerType
Optional

The provider type of the component.

string
parentId
Optional

The ID of the parent component.

object
config
Optional

config


404

Not found

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/tcsa/api/auth-management/v1/components/{id}
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