A user represents an actual person using Concord to execute processes or adminstrate the server.
The REST API provides support for a number of operations:
Creates a new user with specified parameters or updates an existing one using the specified username.
/api/v1/user
POST
Authorization
, Content-Type: application/json
{
"username": "myUser",
"type": "LOCAL",
"roles": ["testRole1", "testRole2"]
}
Allowed type
value:
LOCAL
- a local user, can be authenticated using an API key;LDAP
- a AD/LDAP user, can be authenticated using AD/LDAP credentials or an API key. Content-Type: application/json
{
"ok": true,
"id" : "9be3c167-9d82-4bf6-91c8-9e28cfa34fbb",
"created" : false
}
The created
paratemer indicates whether the user was created or updated.
Find an existing user by name.
/api/v1/user/${username}
GET
Authorization
Content-Type: application/json
{
"id" : "...",
"name" : "myUser"
}
The created
paratemer indicates whether the user was created or updated.
Synchronize LDAP groups for a given user.
/api/v1/userldapgroup/sync
POST
Authorization
, Content-Type: application/json
{
"username": "myUser",
"userDomain": "userDomain"
}
Content-Type: application/json
{
"result": "UPDATED",
"ok": true
}
The UPDATED
result indicates the ldap groups for a specified username got synced successfully.
Note: Only administrators(role: concordAdmin) can synchronize user LDAP groups