_AllUserManagmentREST
- Charles Bishop (Deactivated)
Owned by Charles Bishop (Deactivated)
Jan 30, 2018
Loading data...
This data may be referenced in many pages. By changing the name of this page or its content, you will be affecting many pages throughout the wiki.
{
"addInternalGroup": {
"path": "/rest/user-management/groups",
"method": "POST",
"params": [],
"fields": [
{
"name": "name",
"required": true,
"type": {
"name": "text",
"min": 1,
"max": 255
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"deleteInternalGroup": {
"path": "/rest/user-management/groups/{name}",
"pathVariables": [
"name"
],
"method": "DELETE",
"params": [],
"fields": []
},
"datameerVersion": "4.1.0"
},
{
"findInternalGroups": {
"path": "/rest/user-management/groups",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
}
],
"fields": [
{
"name": "name",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"updateInternalGroup": {
"path": "/rest/user-management/groups/{name}",
"pathVariables": [
"name"
],
"method": "PUT",
"params": [],
"fields": [
{
"name": "name",
"required": true,
"type": {
"name": "text",
"min": 1,
"max": 255
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"addRole": {
"path": "/rest/user-management/roles",
"method": "POST",
"params": [],
"fields": [
{
"name": "name",
"required": true,
"type": {
"name": "text",
"min": 1,
"max": 255
}
},
{
"name": "capabilities",
"required": true,
"type": {
"name": "list",
"min": 1,
"max": 2147483647
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"deleteRole": {
"path": "/rest/user-management/roles/{name}",
"pathVariables": [
"name"
],
"method": "DELETE",
"params": [],
"fields": []
},
"datameerVersion": "4.1.0"
},
{
"findRoles": {
"path": "/rest/user-management/roles",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "term",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
}
],
"fields": [
{
"name": "capabilities",
"sortable": false
},
{
"name": "name",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"updateRole": {
"path": "/rest/user-management/roles/{name}",
"pathVariables": [
"name"
],
"method": "PUT",
"params": [],
"fields": [
{
"name": "name",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255
}
},
{
"name": "capabilities",
"required": false,
"type": {
"name": "list",
"min": 1,
"max": 2147483647
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"addInternalUser": {
"path": "/rest/user-management/users",
"method": "POST",
"params": [
{
"name": "notifyPerMail",
"required": false
}
],
"fields": [
{
"name": "username",
"required": true,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/[a-zA-Z0-9_\\.+\\-@\\s]+/"
}
},
{
"name": "email",
"required": true,
"type": {
"name": "email"
}
},
{
"name": "roles",
"required": true,
"type": {
"name": "list",
"min": 1,
"max": 2147483647
}
},
{
"name": "additionalInformation",
"required": false,
"type": {
"name": "text",
"min": 0,
"max": 4096
}
},
{
"name": "enabled",
"required": false,
"type": {
"name": "boolean"
}
},
{
"name": "expires",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/\\d{4}-\\d{2}-\\d{2}/"
}
},
{
"name": "groups",
"required": false,
"type": {
"name": "list",
"min": 0,
"max": 2147483647
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"deleteInternalUser": {
"path": "/rest/user-management/users/{username}",
"pathVariables": [
"username"
],
"method": "DELETE",
"params": [],
"fields": []
},
"datameerVersion": "4.1.0"
},
{
"findInternalUsers": {
"path": "/rest/user-management/users",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "term",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
},
{
"name": "role",
"required": false
}
],
"fields": [
{
"name": "additionalInformation",
"sortable": false
},
{
"name": "email",
"sortable": true
},
{
"name": "enabled",
"sortable": true
},
{
"name": "expires",
"sortable": true
},
{
"name": "groups",
"sortable": false
},
{
"name": "roles",
"sortable": false
},
{
"name": "username",
"sortable": true
},
{
"name": "lastLoginDate",
"sortable": true
},
{
"name": "loginCount",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"findInternalUserByName": {
"path": "/rest/user-management/users/{username}",
"pathVariables": [
"username"
],
"method": "GET",
"params": [],
"fields": [
{
"name": "additionalInformation",
"sortable": false
},
{
"name": "email",
"sortable": true
},
{
"name": "enabled",
"sortable": true
},
{
"name": "expires",
"sortable": true
},
{
"name": "groups",
"sortable": false
},
{
"name": "roles",
"sortable": false
},
{
"name": "username",
"sortable": true
},
{
"name": "lastLoginDate",
"sortable": true
},
{
"name": "loginCount",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"updateInternalUserPassword": {
"path": "/rest/user-management/password/{username}",
"pathVariables": [
"username"
],
"method": "PUT",
"params": [
{
"name": "notifyPerMail",
"required": false
}
],
"fields": []
},
"datameerVersion": "4.1.0"
},
{
"updateInternalUser": {
"path": "/rest/user-management/users/{username}",
"pathVariables": [
"username"
],
"method": "PUT",
"params": [],
"fields": [
{
"name": "email",
"required": false,
"type": {
"name": "email"
}
},
{
"name": "additionalInformation",
"required": false,
"type": {
"name": "text",
"min": 0,
"max": 4096
}
},
{
"name": "enabled",
"required": false,
"type": {
"name": "boolean"
}
},
{
"name": "expires",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/\\d{4}-\\d{2}-\\d{2}/"
}
},
{
"name": "groups",
"required": false,
"type": {
"name": "list",
"min": 0,
"max": 2147483647
}
},
{
"name": "roles",
"required": false,
"type": {
"name": "list",
"min": 1,
"max": 2147483647
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"updateInternalUsers": {
"path": "/rest/user-management/users",
"method": "PUT",
"params": [],
"fields": [
{
"name": "affectedUser",
"required": true,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/[a-zA-Z0-9_\\.+\\-@\\s]+/"
}
},
{
"name": "additionalInformation",
"required": false,
"type": {
"name": "text",
"min": 0,
"max": 4096
}
},
{
"name": "delete",
"required": false,
"type": {
"name": "boolean"
}
},
{
"name": "email",
"required": false,
"type": {
"name": "email"
}
},
{
"name": "enabled",
"required": false,
"type": {
"name": "boolean"
}
},
{
"name": "expires",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/\\d{4}-\\d{2}-\\d{2}/"
}
},
{
"name": "groups",
"required": false,
"type": {
"name": "list",
"min": 0,
"max": 2147483647
}
},
{
"name": "roles",
"required": false,
"type": {
"name": "list",
"min": 1,
"max": 2147483647
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"findAuthenticableUsers": {
"path": "/rest/user-management/authenticable-users",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "term",
"required": false
},
{
"name": "role",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
}
],
"fields": [
{
"name": "additionalInformation",
"sortable": false
},
{
"name": "email",
"sortable": true
},
{
"name": "enabled",
"sortable": true
},
{
"name": "expires",
"sortable": true
},
{
"name": "groups",
"sortable": false
},
{
"name": "roles",
"sortable": false
},
{
"name": "username",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"findShareableGroups": {
"path": "/rest/user-management/shareable-groups",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "term",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
}
],
"fields": [
{
"name": "name",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"findAvailableUsers": {
"path": "/rest/user-management/available-users",
"method": "GET",
"params": [
{
"name": "group",
"required": false
},
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
}
],
"fields": [
{
"name": "additionalInformation",
"sortable": false
},
{
"name": "email",
"sortable": true
},
{
"name": "enabled",
"sortable": true
},
{
"name": "expires",
"sortable": true
},
{
"name": "groups",
"sortable": false
},
{
"name": "roles",
"sortable": false
},
{
"name": "username",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"findAuthenticatorUsers": {
"path": "/rest/user-management/authenticator/users",
"method": "GET",
"params": [
{
"name": "firstResult",
"required": false
},
{
"name": "maxResults",
"required": false
},
{
"name": "sortBy",
"required": false
},
{
"name": "sortDir",
"required": false
},
{
"name": "term",
"required": false
},
{
"name": "fields",
"required": false
},
{
"name": "pretty",
"required": false
},
{
"name": "role",
"required": false
}
],
"fields": [
{
"name": "additionalInformation",
"sortable": false
},
{
"name": "authenticableGroups",
"sortable": false
},
{
"name": "email",
"sortable": true
},
{
"name": "enabled",
"sortable": true
},
{
"name": "expires",
"sortable": true
},
{
"name": "groups",
"sortable": false
},
{
"name": "importedUser",
"sortable": false
},
{
"name": "roles",
"sortable": false
},
{
"name": "username",
"sortable": true
}
]
},
"datameerVersion": "4.1.0"
},
{
"overrideOwnEmailAndPassword": {
"path": "/rest/user-management/logged-in-user",
"method": "PUT",
"params": [],
"fields": [
{
"name": "email",
"required": false,
"type": {
"name": "email"
}
},
{
"name": "currentPassword",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/[^\\s]+/m"
}
},
{
"name": "newPassword",
"required": false,
"type": {
"name": "text",
"min": 1,
"max": 255,
"regex": "/[^\\s]+/m"
}
}
]
},
"datameerVersion": "4.1.0"
},
{
"findCapabilities": {
"path": "/rest/user-management/capabilities",
"method": "GET",
"params": [
{
"name": "pretty",
"required": false
}
],
"fields": []
},
"datameerVersion": "4.1.0"
},
{
"loggedInUser": {
"path": "/rest/user-management/logged-in-user",
"method": "GET",
"params": [
{
"name": "pretty",
"required": false
}
],
"fields": []
},
"datameerVersion": "4.1.0"
}