The API allows you to list, view, edit and create application users.
Return list of users.
name | type | description | constraints |
---|---|---|---|
active | query | boolean | |
direction | query | ||
filter | query | ||
groups | query | ||
nameLike | query | ||
orderBy | query | ||
page | query | ||
size | query |
media type | data type | description |
---|---|---|
application/json | array of AppUserListRecord (JSON) | list of users |
GET /users
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"active" : true,
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67"
} ]
Create a new user.
media type | data type | description |
---|---|---|
application/json | NewUserRequest (JSON) | specify data for new user |
media type | data type | description |
---|---|---|
application/json | AppUserDetails (JSON) | details of newly created user |
POST /users
Content-Type: application/json
Accept: application/json
{
"login" : "...",
"password" : "...",
"firstName" : "...",
"lastName" : "...",
"thirdPartyRestriction" : "NO_RESTRICTION",
"language" : "CN",
"active" : true,
"infoTourEnabled" : true,
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : "..."
},
"uiTimeZone" : "UTC"
}
HTTP/1.1 201 Created
Content-Type: application/json
{
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"lastFailedLoginIp" : "...",
"source" : "KEYCLOAK",
"language" : "DE",
"active" : true,
"infoTourEnabled" : true,
"endpointsOrganization" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"externalId" : "...",
"thirdPartyRestriction" : "NO_RESTRICTION",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastSuccessfulLogin" : 1451649601000,
"lastFailedLogin" : 1451677502000,
"uiTimeZone" : "UTC"
}
Change active state for specified list of users.
media type | data type | description |
---|---|---|
application/json | SingleAttributeBatchUpdate (JSON) | specify active state and guids of users |
media type | data type | description |
---|---|---|
application/json | BatchResponse (JSON) | list of successful and unsuccessful updates of active state |
PUT /users/active
Content-Type: application/json
Accept: application/json
{
"value" : "...",
"entities" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"successful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"unsuccessful" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
Return list of all possible third party restrictions.
media type | data type | description |
---|---|---|
application/json | array of ThirdPartyRestriction (JSON) | list of all possible third party restrictions |
GET /users/third-party-restrictions
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
"NO_RESTRICTION"
Remove user.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
DELETE /users/{guid}
Content-Type: */*
...
HTTP/1.1 204 No Content
Get a single user.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppUserDetails (JSON) | a single user details |
GET /users/{guid}
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"lastFailedLoginIp" : "...",
"source" : "LOCAL",
"language" : "JA",
"active" : true,
"infoTourEnabled" : true,
"endpointsOrganization" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"externalId" : "...",
"thirdPartyRestriction" : "NO_RESTRICTION",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastSuccessfulLogin" : 1451649601000,
"lastFailedLogin" : 1451677502000,
"uiTimeZone" : "UTC"
}
Change user details.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | UpdateUserRequest (JSON) | specify user details to update |
media type | data type | description |
---|---|---|
application/json | AppUserDetails (JSON) | updated details of user |
PUT /users/{guid}
Content-Type: application/json
Accept: application/json
{
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"language" : "FR",
"active" : true,
"infoTourEnabled" : true,
"externalId" : "...",
"thirdPartyRestriction" : "NO_RESTRICTION",
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : "..."
},
"uiTimeZone" : "UTC",
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ]
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"login" : "...",
"firstName" : "...",
"lastName" : "...",
"lastFailedLoginIp" : "...",
"source" : "LOCAL",
"language" : "CN",
"active" : true,
"infoTourEnabled" : true,
"endpointsOrganization" : {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
},
"groups" : [ {
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}, {
"guid" : "...",
"name" : "..."
} ],
"appUserSettings" : {
"pageSize" : 12345,
"timeFormat" : 12345
},
"externalId" : "...",
"thirdPartyRestriction" : "HORIZON",
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"lastSuccessfulLogin" : 1451649601000,
"lastFailedLogin" : 1451677502000,
"uiTimeZone" : "UTC"
}
Change user Endpoints Organization.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
media type | data type |
---|---|
application/json | NameAndGuid (JSON) |
PUT /users/{guid}/endpoints-organization
Content-Type: application/json
{
"guid" : "f8f73bf9-2445-4bce-a7dd-753be3b40a67",
"name" : "Entity name"
}
HTTP/1.1 204 No Content
Get a list of user groups.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | array of AppUserGroupListRecord (JSON) | a single user details |
GET /users/{guid}/groups
Content-Type: */*
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
[ {
"guid" : "...",
"name" : "...",
"description" : "...",
"deletable" : true,
"defaultLdapGroup" : true,
"defaultKeycloakGroup" : true
} ]
Set user info tour enablement
name | type | description |
---|---|---|
guid | path | local unique identifier for user (use by vProtect) |
media type | data type |
---|---|
application/json | BooleanDTO (JSON) |
PUT /users/{guid}/info-tour
Content-Type: application/json
{
"value" : true
}
HTTP/1.1 204 No Content
Change user password.
name | type | description |
---|---|---|
guid | path | specify local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | StringDTO (JSON) | specify user password |
PUT /users/{guid}/password
Content-Type: application/json
{
"value" : "..."
}
HTTP/1.1 204 No Content
Get user personal settings
name | type | description |
---|---|---|
guid | path | local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppUserSettingsDetails (JSON) |
GET /users/{guid}/settings
Content-Type: application/json
Accept: application/json
...
HTTP/1.1 200 OK
Content-Type: application/json
{
"pageSize" : 12345,
"timeFormat" : 12345
}
Set user personal settings
name | type | description |
---|---|---|
guid | path | local unique identifier for user (use by vProtect) |
media type | data type | description |
---|---|---|
application/json | AppUserSettingsRequest (JSON) | user settings request |
media type | data type | description |
---|---|---|
application/json | AppUserSettingsDetails (JSON) |
PUT /users/{guid}/settings
Content-Type: application/json
Accept: application/json
{
"pageSize" : 12345,
"timeFormat" : "..."
}
HTTP/1.1 204 No Content
Content-Type: application/json
{
"pageSize" : 12345,
"timeFormat" : 12345
}