Post
/group/exportToServer
Starts an asynchronous CSV export of the group members to the SFTP server of a Credential Store entry. Credentials are never passed in the request. Track completion with process/getDetails.
Request body example:
{
"credentialId" : 42,
"listType" : "ACTIVE",
"standardAttributes" : ["user.Email"],
"namedAttributes" : ["*"],
"format" : "CSV"
}
Query parameters
groupId
integer (int64) Required
ID of the group to export
Body parameters
Export options
object
credentialId
integer (int64)
listType
string
standardAttributes
Array of string
string
namedAttributes
Array of string
string
memberAttributes
Array of string
string
format
string
encoding
string
fileName
string
compress
boolean
Defaultfalse
Responses
200
The export process id and initial status.
object
processId
integer (int64)
status
string
Valid values[
"FAILED",
"FINISHED",
"PAUSED",
"PROCESSING"
]
400
A parameter is invalid, an attribute is unknown or the credential is not an SFTP account.
404
The group or credential does not exist or is not visible to the caller.