Getting the details of an MSP user

URI - GET

To use this endpoint, send a GET request with a path parameter user_id: /msp/users/{user_id}

Request

The request includes HTTP headers (obtained in the authentication/authorization process and used to sign the request) and a path parameter (user_id) that represents the user you want to describe.

Request Headers

Header	Type	Required	Format	Description/Sample
x-av-req-id	String	Yes	UUID – generated and supplied on the request	d290f1ee-6c54-4b01-90e6-d701748f0851
x-av-token	String	Yes	Token obtained in the authentication sequence	tkn8546ffffggd9d8934593
x-av-app-id	String	Yes	Application ID provided by Avanan	myapp29
x-av-date	String	Yes	Date-time in GMT	'2016-08-29T09:12:33.001Z'
x-av-sig	String	Yes	Calculated signature	tkn8jmveolrrtertr9d8934593

Request String Parameters

Parameter	Type	Required	Format	Description/Sample
user_id	String	Yes		Unique user ID

Request sample (CURL) format

This request sample shows URI base in USA region. For URI base in other regions, see MSP Types.

Copy

curl -X GET -H "Accept: application/json" \
    -H "x-av-req-id: d290f1ee-6c54-4b01-90e6-d701748f0851" \
    -H "x-av-token: tkn8546ffffggd9d8934593" \
    -H "x-av-app-id: myapp29" \
    -H "x-av-date: 2016-08-29T09:12:33.001Z" \
    -H "x-av-sig: tkn8jmveolrrtertr9d8934593" \
    https://smart-api-production-1-us.avanan.net/v1.0/msp/users/12

Response

The response obtained from the service includes an HTTP response code and JSON formatted structure. The structure consists of a responseEnvelope structure and a responseData structure that shows information related to the requested user.

Response Structure

Copy

{
  "responseEnvelope": {
    "requestId": "string",
    "responseCode": 0,
    "responseText": "",
    "additionalText": "",
    "recordsNumber": 0,
    "scrollId": "string"
  },
  "responseData": {
    "id": 0,
    "email": "string",
    "firstName": "string",
    "lastName": "string",
    "role": "string",
    "samlLogin": true,
    "directLogin": true,
    "viewPrivateData": true,
    "sendAlerts": true,
    "receiveWeeklyReports": true
  }
}

Response Parameters

The response parameters:

Parameter		Type	Description
responseEnvelope		Object	A container of metadata properties
	requestId	String	Request ID (from the request header x-av-req-id value)
	responseCode	Integer	0 = Success Other values = Failure
	responseText	String	Text value of response
	additionalText	String	Additional information
	recordsNumber	Integer	Number of records in the response
	totalRecordsNumber	Integer	Total number of records
	scrollId	String	A unique ID used to scroll through data
responseData		Object	User Object
	id	Integer	Unique ID of the user
	email	String	User email
	firstName	String	User first name
	lastName	String	User last name
	role	String	Role of the user. One of admin, operations, user, and read-only
	samlLogin	Boolean	SAML login enabled for the user
	directLogin	Boolean	Password login enabled for the user
	viewPrivateData	Boolean	Allow the user to view private data on the customer portal
	sendAlerts	Boolean	Send alerts from customer tenants to this admin
	receiveWeeklyReports	Boolean	Send weekly reports from customer tenants to this admin

Response Sample

A valid response from the service:

Copy

{
  "responseEnvelope": {
    "requestId": "cc7796ac-6235-4a06-b7e9-6abc557976f6",
    "responseCode": 200,
    "responseText": "Success",
    "additionalText": "",
    "recordsNumber": 1,
    "totalRecordsNumber": 1,
    "scrollId": ""
  },
  "responseData": {
    {
      "id": 1,
      "email": "johndoe@abccompany.com",
      "firstName": "John",
      "lastName": "Doe",
      "role": "admin",
      "samlLogin": true,
      "directLogin": true,
      "privateData": true,
      "sendAlerts": true,
      "receiveWeeklyReports": true
    }
}