Get User

Release Time

06/07/2018

Views

615 times

Tags

No results found.

Description

Get Users

This resource provides users.

Scheme

https

Host

Valid ITSM host (example: subdomain-msp.cmdm.comodo.com )

Path

/api/rest/v1/user

Query Params

Param Name	Description	Limitations
page	interested page
page-size	how many results in answer	max is 200

Request Headers

Key	Value	Description
Http method	GET	Http method
Content-Type	application/json
x-auth-type	4	Authentication type identifier
x-auth-token	access token	3rd Party Authentication token

See the below links for more detail:

Execution

Sample execution can be handled via Postman Application.

Header part can be handled via Postman Application

Success Output

 Get Users
Get Users
This resource provide users. 

Scheme

https

Host

Valid ITSM host (example: subdomain-msp.cmdm.comodo.com )

Path 

/api/rest/v1/user

Query Params
page	interested page	
page-size	how many results in answer	max is 200


Request Headers
Http method	GET	Http method
Content-Type	application/json	
x-auth-type	4	Authentication type identifier
x-auth-token	access token	3rd Party Authentication token
See 3rd Party Authentication API Definition for more detail

Response
Response
{
  "title": "Response of users",
  "type": "object",
  "properties": {
    "search": {
      "type": "object",
      "properties": {
        "page": {
          "type": "number",
          "description": "Current page"
        },
        "page_size": {
          "type": "number",
          "description": "Current page size"
        }
      }
    },
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "number",
            "description": "User identifier"
          },
          "name": {
            "type": "string",
            "description": "User name"
          },
          "email": {
            "type": "string",
            "description": "User E-Mail"
          },
          "company_id":{
            "type":"number",
            "description":"Company identifier, where User assigned on."    
          }
        }
      }
    }
  }
}


Possible HTTP codes
200	Ok.
400	Bad request
401	Unauthorized
403	Forbidden
404	Not found


Examples
 Click here to expand...

Error Output

Possible  HTTP codes
200	      Ok.
400	      Bad request
401	      Unauthorized
403   	  Forbidden
404	      Not found