It seems like your browser didn't download the required fonts. Please revise your security settings and try again.
Barracuda Campus Barracuda Campus
Barracuda Intronis Backup
formerly ECHOplatform
Overview Documentation Materials

Partner User List

  • Last updated on

URI

/v1/partners/{username}/users

URI Parameters

  • username (string)

Methods

GET, POST

GET /v1/partners/{username}/users

Gets a partner's users.

Scope

partners_read

Query Selector Parameters

  • role (string const) – ADMIN|TECH|FINANCE – If no role is specified, then all roles will be returned

Query Pagination Parameters

  • page (int) – the page to show (min 1, default 1)
  • page_size (int) – the number of users per page min1, max 50, default 10)

Query Sorting Parameters

  • order_by (string const) – USERNAME|NAME
  • order_dir (string const) – ASC|DESC

Request Body Parameters

  • n/a

Response Attributes

  • username (string)
  • name (string)
  • role (string const) – ADMIN|TECH|FINANCE
  • link (link object)

Example JSON

Request:

GET /v1/partners/barracuda/users HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/json

 

Response:

HTTP/1.1 200 OK

Content-Type: application/json

 

{

  "page": 1,

  "page_size": 10,

  "count": 2,

  "links": [

   {

     "rel": "first",

     "href": "https://api.intronis.com/v1/partners/barracuda/users?page=1"

   },

  ],         

  "list": [

   {

     "username": "tech_user",

     "name": "John Smith",

     "role": "TECH",

     "link": {

       "rel": "self",

       "href": "https://api.intronis.com/v1/partners/barracuda/users/tech_user"

     }

   },

   {                

     "username": "admin_user",

     "name": "John Smith",

     "role": "ADMIN",

     "link": {

       "rel": "self",

       "href": "https://api.intronis.com/v1/partners/barracuda/users/admin_user"

     }

   }

  ]

}

Example XML

Request:

GET /v1/partners/barracuda/users HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Accept: application/xml

 

Response:

HTTP/1.1 200 OK

Content-Type: application/xml

 

<?xml version="1.0" encoding="UTF-8"?>

<list page="2" page_size="10" count="2">

  <link rel="first" href="https://api.intronis.com/v1/partners/barracuda/users?page=1"/>

  <user>

   <username>tech_user</username>

   <name>John Smith</name>

   <role>TECH</role>

   <link rel="self" href="https://api.intronis.com/v1/partners/barracuda/users/tech_user"/>

  </user>

  <user>

   <username>admin_user</username>

   <name>John Smith</name>

   <role>ADMIN</role>

   <link rel="self" href="https://api.intronis.com/v1/partners/barracuda/users/admin_user"/>

  </user>

</list>

POST /v1/partners/{username}/users

Adds a new user to the partner.

Scope

partners_write

Request Body Parameters

  • username (string)
  • password (string)
  • name (string)
  • company (string)
  • street_address (string)
  • street_address2 (string)
  • city (string)
  • state (string)
  • zip (string)
  • country (string) - deprecated
  • country_iso (string)
  • email (string)
  • phone (string)
  • role (string const) – ADMIN|TECH|FINANCE

Response Attributes

  • n/a

Example JSON

Request:

POST /v1/partners/barracuda/users HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/json

 

{

  "username": "tech_user",

  "password": "ps8wEzeT",

  "name": "John Smith",

  "company": "barracuda",

  "street_address": "334 Congress Street",

  "street_address2": "",

  "city": "Boston",

  "state": "MA",

  "zip": "02210",

  "country": "USA",

  "country_iso": "US",

  "email": "jsmith@barracuda.com",

  "phone": "617-948-5300",

  "role": "TECH"

}

Response:

HTTP/1.1 201 Created

Location: https://api.intronis.com/v1/partners/barracuda/users/tech_user

Example XML

Request:

POST /v1/partners/barracuda/users HTTP/1.1

Host: api.intronis.com

Authorization: OAuth vF9dft4qmT

Content-Type: application/xml

 

<?xml version="1.0" encoding="UTF-8" ?>

<user>

  <username>tech_user</username>

  <password>ps8wEzeT</password>

  <name>John Smith</name>

  <company>barracuda</company>

  <street_address>334 Congress Street</street_address>

  <street_address2/>

  <city>Boston</city>

  <state>MA</state>

  <zip>02210</zip>

  <country>USA</country>

  <country_iso>US</country_iso>

  <email>jsmith@barracuda.com</email>

  <phone>617-948-5300</phone>

  <role>TECH</role>

</user>

 

Response:

HTTP/1.1 201 Created

Location: https://api.intronis.com/v1/partners/barracuda/users/tech_user