BrokerDirectorySwitchProvisioningResponseMedia

Represents response details for switching provisioning type

JSON Example

{
    "brokerDirectoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "idpId": "f4d49163-1cb3-4a8b-b966-03528c747097",
    "provisioningType": "LDAP",
    "jitPreProvisioningGroups": {
        "preProvisionedGroupsEnabled": true,
        "preProvisionedGroups": [
            {
                "domain": "mydomain1.com",
                "groups": [
                    "[ 'group1',  'group2' ]"
                ]
            }
        ]
    },
    "status": "COMPLETED",
    "preview": false,
    "errorMessage": "string",
    "directoriesConfiguration": [
        {
            "ldapConfigUUid": "string",
            "brokerDirectoryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "directoryConfigWarningMessage": "Target domain does not match the domain from the LDAP configuration",
            "domain": "myDomain.com",
            "migrationStatus": "COMPLETED"
        }
    ],
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    }
}

string As uuid As uuid

brokerDirectoryId

Optional

The unique identifier of the directory

string As uuid As uuid

idpId

Optional

The id of Identity Provider

string

provisioningType

Optional

The provisioning type of the directory

Possible values are : LDAP, JIT,

JitPreProvisioningGroups

jitPreProvisioningGroups

Optional

Configuration for JIT pre-provisioning groups

string

status

Optional

The status of switching provisioning type

Possible values are : COMPLETED, ERROR,

boolean

preview

Optional

If preview is true the switch provisioning process will not be started, only validation of ldap directory configuration will be performed. If there is an error, for example domain mismatch return warning message in the response. If preview is false then start switch provisioning process. Applicable for LDAP provisioning type

string

errorMessage

Optional

Error message return when switching provisioning fails

array of BrokerDirectoryConfiguration

directoriesConfiguration

Optional

Directory configuration details

object

_links

Optional

The resource HATEOAS links. Usually includes a "self" link for this resource