Authentication

Edit online

Use this method reference for using the Ceph RESTful API auth endpoint to initiate a session with IBM Storage Ceph.

POST /api/auth

Edit online
Curl example
curl -i -k --location -X POST https://192.168.0.44:8443/api/auth -H Accept: application/vnd.ceph.api.v1.0+json -H Content-Type: application/json --data {"password": "admin@123", "username": "admin"}
Example
 POST /api/auth HTTP/1.1
 Host: example.com
 Content-Type: application/json

 {
     "password": "STRING",
     "username": "STRING"
 }
Status codes
  • 201 Created – Resource created.
  • 202 Accepted – Operation is still executing. Please check the task queue.
  • 400 Bad Request – Operation exception. Please check the response body for details.
  • 401 Unauthorized – Unauthenticated access. Please login first.
  • 403 Forbidden – Unauthorized access. Please check your permissions.
  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

POST /api/auth/check

Edit online
Description

Check the requirement for an authentication token.

Example
POST /api/auth/check?token=STRING HTTP/1.1
Host: example.com
Content-Type: application/json

{
    "token": "STRING"
}
Status codes
  • 201 Created – Resource created.
  • 202 Accepted – Operation is still executing. Please check the task queue.
  • 400 Bad Request – Operation exception. Please check the response body for details.
  • 401 Unauthorized – Unauthenticated access. Please login first.
  • 403 Forbidden – Unauthorized access. Please check your permissions.
  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.

POST /api/auth/logout

Edit online
Status codes
  • 201 Created – Resource created.
  • 202 Accepted – Operation is still executing. Please check the task queue.
  • 400 Bad Request – Operation exception. Please check the response body for details.
  • 401 Unauthorized – Unauthenticated access. Please login first.
  • 403 Forbidden – Unauthorized access. Please check your permissions.
  • 500 Internal Server Error – Unexpected error. Please check the response body for the stack trace.