Authentication
POST /login
Start an OpsCenter session. You must use an authentication method that submits a username and password to the login page. The following example uses curl.
Returns a JSON object with a token for the session. This token can be passed as an opscenter-session header to authenticate future requests in the session. A cookie for the same purpose is also set for clients that support them.
Example:
curl -X POST -d '{"username":"admin","password":"test"}' 'http://localhost:8888/login'Output:
{"sessionid": "d6c5e198b9b5ffeab9fd8dea6fb012aa"}
Example with SSL:
curl -X POST -d '{"username":"admin","password":"admin"}' \
-k --cert /var/lib/opscenter/ssl/opscenter.pem \
--key /var/lib/opscenter/ssl/opscenter.key 'https://localhost:8443/login'Output:
{"sessionid": "d6c5e198b9b5ffeab9fd8dea6fb012aa"}
GET /logout
End an OpsCenter session. The following example uses curl.
Example:
curl -X GET -H 'opscenter-session: 1948fa886a91a1905a29192cf209114d' 'http://localhost:8888/logout'Output:
{}
User Administration Methods
|
In the following user administration method examples, the value for |
GET /permissions/user
Get a map of permissions for the currently authenticated user.
Returns a JSON object with a mapping of permissions for every cluster.
Example:
curl -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/permissions/userOutput:
{"Test_Cluster": {"View Cluster": true}}
GET /permissions/roles
Get a list of all roles in OpsCenter (requires permissions).
Example:
curl -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/permissions/rolesOutput:
{"roles": ["user"]}
GET /permissions/roles/{role_id}
Get all permissions for a specific role.
Example:
curl -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/permissions/roles/test_roleOutput:
{"Test_Cluster": {"View Cluster": true}
PUT /permissions/roles/{role_id}
Update all permissions for a specific role.
Example:
curl -H 'Accept: application/json' -H 'opscenter-session: 12345ABC' \
-X PUT -d '{"Test_Cluster": {"View Cluster": true}}' http://127.0.0.1:8888/permissions/roles/test_roleNo output.
POST /permissions/roles/{role_id}
Create permissions for a specific role.
Example:
curl -H 'opscenter-session: 12345ABC' -H 'Accept: application/json' \
-X POST -d '{"Test_Cluster": {"View Cluster": true}}' http://127.0.0.1:8888/permissions/roles/test_roleNo output.
DELETE /permissions/roles/{role_id}
Delete all permissions for a specific role.
Example:
curl -H 'opscenter-session: 12345ABC' \
-X DELETE http://127.0.0.1:8888/permissions/roles/test_roleNo output.
GET /users
Get the list of all users.
Example:
|
In addition to the |
curl -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/usersOutput:
[
{
"roles": ["power_user"],
"username": "testuser"
}
]
GET /users/{username}
Gets the role of a user.
Returns username/role.
Example:
curl -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/users/testuserOutput:
{"username": "testuser", "role": "power_user", "roles": ["power_user"]}
POST /users/{username}
Creates a new user and accepts a JSON map with a password and role.
Example:
curl -H 'opscenter-session: 12345ABC' \
-H 'Accept: application/json' \
-d '{"password": "test", "role": "test_role"}' \
-X POST http://127.0.0.1:8888/users/testuserNo output.
PUT /users/{username}
Updates an existing user, accepts a JSON map with a password, a role, or both.
Users can update their own password and they must supply the additional "old_password" parameter that must match their current password. Users can update their own role only if they are an admin user.
Example:
curl -H 'opscenter-session: 12345ABC' \
-H 'Accept: application/json' \
-d '{"password": "test", "old_password": "changeme" }' \
-X PUT http://127.0.0.1:8888/users/testusercurl -H 'opscenter-session: 12345ABC' \
-H 'Accept: application/json' \
-d '{"password": "test", "role": "test_role"}' \
-X PUT http://127.0.0.1:8888/users/otheruserNo output.
DELETE /users/{username}
Deletes an existing user.
Example:
curl -X DELETE -H 'opscenter-session: 12345ABC' http://127.0.0.1:8888/users/testuserNo output.
