Get the details for a specific user. You can use the include parameter to also get the details of related records, such as the account or the home directory.
Notes:
- You must have access to use this.
643 matches
49 actions
ExaVault
49 actions
- Complete send filesPOSTv1.0.0
- Compress resourcesPOSTv1.0.0
- Copy resourcesPOSTv1.0.0
- Create a folderPOSTv1.0.0
- Create a new notificationPOSTv1.0.0
- Create a new SSH KeyPOSTv1.0.0
- Create a userPOSTv1.0.0
- Create new email listPOSTv1.0.0
- Creates a sharePOSTv1.0.0
- Deactivate a shareDELETEv1.0.0
- Delete a notificationDELETEv1.0.0
- Delete a receive form submissionDELETEv1.0.0
- Delete a ResourceDELETEv1.0.0
- Delete a userDELETEv1.0.0
- Delete an email group with given idDELETEv1.0.0
- Delete an SSH KeyDELETEv1.0.0
- Delete ResourcesDELETEv1.0.0
- Extract resourcesPOSTv1.0.0
- Get a list of all resourcesGETv1.0.0
- Get a list of notificationsGETv1.0.0
- Get a list of sharesGETv1.0.0
- Get a list of usersGETv1.0.0
- Get a shareGETv1.0.0
- Get account settingsGETv1.0.0
- Get activity logsGETv1.0.0
- Get all email groupsGETv1.0.0
- Get form data entries for a receiveGETv1.0.0
- Get individual email groupGETv1.0.0
- Get info for a userGETv1.0.0
- Get metadata for a list of SSH KeysGETv1.0.0
- Get metadata for an SSH KeyGETv1.0.0
- Get notification detailsGETv1.0.0
- Get receive folder form by IdGETv1.0.0
- Get receive folder form settingsGETv1.0.0
- Get resource metadataGETv1.0.0
- Get Resource PropertiesGETv1.0.0
- List contents of folderGETv1.0.0
- Move resourcesPOSTv1.0.0
- Preview a fileGETv1.0.0
- Rename a resource.PATCHv1.0.0
- Resend invitations to share recipientsPOSTv1.0.0
- Resend welcome email to specific userPOSTv1.0.0
- Send referral email to a given addressPOSTv1.0.0
- Update a notificationPATCHv1.0.0
- Update a sharePATCHv1.0.0
- Update a userPATCHv1.0.0
- Update account settingsPATCHv1.0.0
- Update an email groupPATCHv1.0.0
- Updates a form with given parametersPATCHv1.0.0
Storage/ExaVault
Get info for a user
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
{
"type": "object",
"properties": {
"ev-access-token": {
"type": "string"
},
"ev-api-key": {
"type": "string"
},
"include": {
"type": "string"
}
},
"required": [
"ev-access-token",
"ev-api-key"
],
"additionalProperties": false
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
- 98
- 99
- 100
- 101
- 102
- 103
- 104
- 105
- 106
- 107
- 108
- 109
- 110
- 111
- 112
- 113
- 114
- 115
- 116
- 117
- 118
- 119
- 120
- 121
- 122
- 123
- 124
- 125
- 126
- 127
- 128
- 129
- 130
- 131
- 132
- 133
- 134
- 135
- 136
- 137
- 138
- 139
- 140
- 141
- 142
- 143
- 144
- 145
- 146
- 147
- 148
- 149
- 150
- 151
- 152
- 153
- 154
- 155
- 156
- 157
- 158
- 159
- 160
- 161
- 162
- 163
- 164
- 165
- 166
- 167
- 168
- 169
- 170
- 171
- 172
- 173
- 174
- 175
- 176
- 177
- 178
- 179
- 180
- 181
- 182
- 183
- 184
- 185
- 186
- 187
- 188
- 189
- 190
- 191
- 192
- 193
- 194
- 195
- 196
- 197
- 198
- 199
- 200
- 201
- 202
- 203
- 204
- 205
- 206
- 207
- 208
- 209
- 210
- 211
- 212
- 213
- 214
- 215
- 216
- 217
- 218
- 219
- 220
- 221
- 222
- 223
- 224
- 225
- 226
- 227
- 228
- 229
- 230
- 231
- 232
{
"type": "object",
"description": "Response object for users.",
"properties": {
"data": {
"type": "object",
"description": "Object contains user properties.",
"properties": {
"attributes": {
"type": "object",
"description": "Attributes of the user including expiration, home directory, and permissions. ",
"required": [
"accountName",
"created",
"homeResource",
"modified",
"nickname",
"onboarding",
"permissions",
"role",
"status",
"timeZone",
"username"
],
"properties": {
"accessTimestamp": {
"type": "string",
"description": "Timestamp of most recent successful user login."
},
"accountName": {
"type": "string",
"description": "Name of the account this user belongs to."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user creation."
},
"email": {
"type": "string",
"description": "Email address of the user."
},
"expiration": {
"type": "string",
"description": "Timestamp of user expiration."
},
"firstLogin": {
"type": "boolean",
"description": "`true` if the user has logged into the system."
},
"homePath": {
"type": "string",
"description": "Path to the user's home folder."
},
"locked": {
"type": "boolean",
"description": "`true` if the user is locked and cannot log in."
},
"modified": {
"type": "string",
"format": "date-time",
"description": "Timestamp of user modification."
},
"nickname": {
"type": "string",
"description": "Nickname of the user."
},
"onboarding": {
"type": "boolean",
"description": "Whether the onboarding help system is enabled for this user. `true` means that additional help popups are displayed in the web application for this user."
},
"permissions": {
"type": "object",
"required": [
"changePassword",
"delete",
"deleteFormData",
"download",
"list",
"modify",
"notification",
"share",
"upload",
"viewFormData"
],
"properties": {
"changePassword": {
"type": "boolean",
"description": "Change (own) password permission flag"
},
"delete": {
"type": "boolean",
"description": "Delete permission flag"
},
"deleteFormData": {
"type": "boolean",
"description": "Delete form data permission flag. If true, user can remove data that was submitted for a receive folder. This applies only to data submitted in the receive folder form, not the actual files uploaded."
},
"download": {
"type": "boolean",
"description": "Download permission flag"
},
"list": {
"type": "boolean",
"description": "View folder contents permission flag"
},
"modify": {
"type": "boolean",
"description": "Modify permission flag"
},
"notification": {
"type": "boolean",
"description": "Notifications permission flag"
},
"share": {
"type": "boolean",
"description": "Sharing permission flag"
},
"upload": {
"type": "boolean",
"description": "Upload permission flag"
},
"viewFormData": {
"type": "boolean",
"description": "Access Form Data permission flag. If true, user can view submissions that have been stored for a receive folder. This includes any data submitted in the receive folder form."
}
}
},
"role": {
"type": "string",
"description": "User's access level",
"enum": [
"user",
"admin",
"master"
]
},
"status": {
"type": "integer",
"format": "int32",
"description": "Indicates user activity status. `0` means the user is locked and cannot log in. `1` means the user is active and can log in.",
"enum": [
0,
1
]
},
"timeZone": {
"type": "string",
"description": "User's timezone. See <a href='https://php.net/manual/en/timezones.php' target='blank'>this page</a> for allowed values."
},
"username": {
"type": "string",
"description": "Username of the user."
}
}
},
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the user."
},
"relationships": {
"type": "object",
"description": "Home resource and owner account relationship data for the user. ",
"required": [
"ownerAccount"
],
"properties": {
"homeResource": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64",
"description": "ID of home directory resource."
},
"type": {
"type": "string",
"description": "Type is resource.",
"enum": [
"resource"
]
}
}
}
}
},
"ownerAccount": {
"type": "object",
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int32",
"description": "ID of the account."
},
"type": {
"type": "string",
"description": "Type is account.",
"enum": [
"account"
]
}
}
}
}
}
}
},
"type": {
"type": "string",
"description": "Type of object being returned. Always \"user\""
}
}
},
"included": {
"type": "array",
"items": {
"type": "object"
}
},
"responseStatus": {
"type": "integer",
"description": "Http code for the response."
}
}
}