Creates a templated CSV download for users based on batchID
GET /users/templates/{templateName}/users
Operation id: UserService_GetTemplatedUsersFile
Description
Permission Level: Read
Tags: UserService
Parameters
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
templateName | string | Yes | Template name of the template to use for downloading batch users, Required: true |
Query parameters
| Name | Type | Required | Description |
|---|---|---|---|
batchId | string | No | batch_id of the users to be downloaded. If missing, download all the tenant users. Required: false |
includeClients | boolean | No | Flag to include clients, Default: false, Required: false if its set to true, all the client users(is_client: true) will be fetched. |
scope | string | No | Will only download users enabled for that particular scope. Required: false |
tenantId | string | No | tenant_id of the users, Required: false |
Security
- Authorization (apiKey)
- Bearer token
Responses
200 — A successful response.(streaming responses)
Content type: application/json
default — An unexpected error response.
Content type: application/json
Response models
200 — A successful response.(streaming responses)
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
result | object | No | |
error | object | No |
{
"type": "object",
"properties": {
"result": {
"type": "object",
"properties": {
"data": {
"type": "string",
"format": "byte"
}
}
},
"error": {
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}
}
}
default — An unexpected error response.
Content type: application/json
Schema
| Property | Type | Required | Description |
|---|---|---|---|
code | integer (int32) | No | |
message | string | No | |
details | array | No |
{
"type": "object",
"properties": {
"code": {
"type": "integer",
"format": "int32"
},
"message": {
"type": "string"
},
"details": {
"type": "array",
"items": {
"type": "object",
"properties": {
"@type": {
"type": "string"
}
}
}
}
}
}