You can check the endpoints and methods that a particular user is authorized to access.

URL

GET https:<IP-address-of-SPS>/api/user_info

Cookies

Cookie name	Description	Required	Values
session_id	Contains the authentication token of the user	Required	The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API. NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).

Sample request

The following command retrieves user information from SPS about the logged in user, using the session ID received during the authentication.

curl --cookie cookies https://<IP-address-of-SPS>/api/user_info

This information is also available on the /api/user/info and /api/userinfo endpoints.

Response

The following is a sample response received if the request to retrieve user information is successful.

For more information on the meta object, see Message format.

{
  "user": {  
    "name": "admin",
  }
  "endpoints": [
    {
      "methods": [
        "DELETE",
        "GET",
        "POST",
        "PUT" 
      ],
      "url": "/api"
    },
    {
      "...": "..."
    }
  ],
  "meta": {
    "href": "/api/user_info",
    "...": "..."
  }
}

Element		Type	Description
user			Top-level element, contains the details of the user whose access rights information has been retrieved.
	name	string	The username of the logged-in user whose information has been retrieved.
endpoints			Top-level element, contains the details of the endpoints that the user is authorized to access.
	methods	string	The methods that user is authorized to use, and the permitted HTTP method (for example, GET, POST) for each endpoint. This information is also available on the /api/endpoints endpoint.
	url	string	The resource that the user is authorized to access.

Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code	Description	Notes
200	OK	User information has been retrieved successfully.
401	Unauthenticated	The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403	Unauthorized	The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.