Get User Federation Configuration

This API is used to retrieve user-federation configuration.

Request

URI

GET

https://{api_host}/tcsa.host.com/tcsa/api/auth-management/v1/components/{id}

COPY

Path Parameters

string

Required

Unique id of user-federation configuration.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

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.