Abiquo Documentation Cookies Policy

Our Documentation website uses cookies to improve your experience. Please visit our Cookie Policy page for more information about cookies and how we use them.


Abiquo 4.4

Skip to end of metadata
Go to start of metadata

Contents:

Roles Resource

You can use the Roles Resource to manage roles in the platform, where each role is a collection of privileges representing the actions that a user with the role is allowed to perform, and optionally associated with external roles, such as those defined in LDAP or Active Directory.

Main URI of the Resource

This class operates mainly over the Resource URI: /admin/roles

Exposed Methods

List Roles

Return all roles of an enterprise.

Paging Method

This method works with paging. Check out Basic Behaviors for information about how it works

Synopsis: GET http://example.com/api/admin/roles
Roles Required: AUTHENTICATED,USERS_MANAGE_ROLES,USERS_VIEW_PRIVILEGES,USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.roles+json; version=4.4; application/vnd.abiquo.roles+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

identerprise

false

 

identifier of the enterprise

startwith

false

0

first element to retrieve

by

false

name

ordering the request.

has

false

 

filter the request. With this parameter the response just contains the elements
which name matches the filter value.

limit

false

25

number of elements to return

asc

false

true

order ascendant or descendant. By default the sort mode is ascending.

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Roles Media Type
Request Example:

List roles

 Click here to show or hide the request example

 

GET_adm_roles_AC_roles_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/roles \ 
	 -H 'Accept:application/vnd.abiquo.roles+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 2, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles?limit=25&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles?startwith=0&limit=25&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "id": 6346, 
      "name": "26", 
      "externalRoles": [], 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/roles/6346", 
          "type": "application/vnd.abiquo.role+json", 
          "rel": "edit", 
          "title": "26"
        }, 
        {
          "href": "http://localhost:9009/api/admin/roles/6346/action/privileges", 
          "type": "application/vnd.abiquo.privileges+json", 
          "rel": "privileges", 
          "title": "privileges"
        }
      ], 
      "blocked": false
    }, 
    {
      "id": 6343, 
      "name": "sysRole", 
      "externalRoles": [], 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/roles/6343", 
          "type": "application/vnd.abiquo.role+json", 
          "rel": "edit", 
          "title": "sysRole"
        }, 
        {
          "href": "http://localhost:9009/api/admin/roles/6343/action/privileges", 
          "type": "application/vnd.abiquo.privileges+json", 
          "rel": "privileges", 
          "title": "privileges"
        }
      ], 
      "blocked": false
    }
  ]
}

List roles filtered by enterprise

 Click here to expand...

GET_adm_roles_AC_roles_j_ident_lmt.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/roles?identerprise=6337&limit=0 \ 
	 -H 'Accept:application/vnd.abiquo.roles+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "totalSize": 3, 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles?identerprise=6337&limit=0&by=name&asc=true", 
      "rel": "first"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles?identerprise=6337&startwith=0&limit=0&by=name&asc=true", 
      "rel": "last"
    }
  ], 
  "collection": [
    {
      "idEnterprise": 6337, 
      "name": "24", 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/roles/6344", 
          "type": "application/vnd.abiquo.role+json", 
          "rel": "edit", 
          "title": "24"
        }, 
        {
          "href": "http://localhost:9009/api/admin/enterprises/6337", 
          "type": "application/vnd.abiquo.enterprise+json", 
          "rel": "enterprise", 
          "title": "20"
        }, 
        {
          "href": "http://localhost:9009/api/admin/roles/6344/action/privileges", 
          "type": "application/vnd.abiquo.privileges+json", 
          "rel": "privileges", 
          "title": "privileges"
        }
      ], 
      "blocked": false, 
      "id": 6344, 
      "externalRoles": []
    }, 
    {
      "id": 6346, 
      "name": "26", 
      "externalRoles": [], 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/roles/6346", 
          "type": "application/vnd.abiquo.role+json", 
          "rel": "edit", 
          "title": "26"
        }, 
        {
          "href": "http://localhost:9009/api/admin/roles/6346/action/privileges", 
          "type": "application/vnd.abiquo.privileges+json", 
          "rel": "privileges", 
          "title": "privileges"
        }
      ], 
      "blocked": false
    }, 
    {
      "id": 6343, 
      "name": "sysRole", 
      "externalRoles": [], 
      "links": [
        {
          "href": "http://localhost:9009/api/admin/roles/6343", 
          "type": "application/vnd.abiquo.role+json", 
          "rel": "edit", 
          "title": "sysRole"
        }, 
        {
          "href": "http://localhost:9009/api/admin/roles/6343/action/privileges", 
          "type": "application/vnd.abiquo.privileges+json", 
          "rel": "privileges", 
          "title": "privileges"
        }
      ], 
      "blocked": false
    }
  ]
}

 

Create a role

Create a new role. To create an Abiquo role associated with an LDAP role, use the standard role methods and include the externalRoles attribute, which is a comma separated list of external role names.

Synopsis: POST http://example.com/api/admin/roles
Roles Required: USERS_MANAGE_ROLES
Request Headers: Accept: application/vnd.abiquo.role+json; version=4.4; application/vnd.abiquo.role+xml; version=4.4;  Content-type:  application/vnd.abiquo.role+json; version=4.4; application/vnd.abiquo.role+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: Role Media Type
Response Message Body Entity: Role Media Type
Request Example:

 Click here to show or hide the request example

POST_adm_roles_CT_role_j_AC_role_j.0001.txt

cURL:

curl -X POST http://localhost:9000/api/admin/roles \ 
	 -H 'Accept:application/vnd.abiquo.role+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.role+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 201

Request payload:

{
  "blocked": false, 
  "externalRoles": [
    "ROLE_LDAP2", 
    "ROLE_LDAP1"
  ], 
  "links": [], 
  "name": "NEW_NAME_WE"
}

Response payload:

{
  "id": 6356, 
  "name": "NEW_NAME_WE", 
  "externalRoles": [
    "ROLE_LDAP1", 
    "ROLE_LDAP2"
  ], 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles/6356", 
      "type": "application/vnd.abiquo.role+json", 
      "rel": "edit", 
      "title": "NEW_NAME_WE"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles/6356/action/privileges", 
      "type": "application/vnd.abiquo.privileges+json", 
      "rel": "privileges", 
      "title": "privileges"
    }
  ], 
  "blocked": false
}

 

 

Get a role

Get information about an existing role.

Synopsis: GET http://example.com/api/admin/roles/{role}
Roles Required: AUTHENTICATED,USERS_MANAGE_ROLES,USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.role+json; version=4.4; application/vnd.abiquo.role+xml; version=4.4;  Content-type: ;

Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Role Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_roles_X_AC_role_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/roles/803 \ 
	 -H 'Accept:application/vnd.abiquo.role+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "id": 803, 
  "name": "6", 
  "externalRoles": [], 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles/803", 
      "type": "application/vnd.abiquo.role+json", 
      "rel": "edit", 
      "title": "6"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles/803/action/privileges", 
      "type": "application/vnd.abiquo.privileges+json", 
      "rel": "privileges", 
      "title": "privileges"
    }
  ], 
  "blocked": false
}

List links to privileges of a role

Retrieves the list of links to privileges associated with a role.

Synopsis: GET http://example.com/api/admin/roles/{role}/action/privileges
Roles Required: AUTHENTICATED,USERS_VIEW_PRIVILEGES,USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.links+json; version=4.4; application/vnd.abiquo.links+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Links Media Type
Request Example:

 Click here to show or hide the request example

GET_adm_roles_X_act_privs_AC_lnks_j.0001.txt

cURL:

curl -X GET http://localhost:9000/api/admin/roles/807/action/privileges \ 
	 -H 'Accept:application/vnd.abiquo.links+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
  "links": [
    {
      "href": "http://localhost:9009/api/config/privileges/68893", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "AUTHENTICATED"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68895", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_DOWNLOAD_IMAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68894", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_ALLOW_MODIFY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68897", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_MANAGE_GLOBAL_CATEGORIES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68896", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_MANAGE_CATEGORIES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68899", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_SHOW_DC_CAPACITY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68898", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_MANAGE_REPOSITORY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68901", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68900", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_UPLOAD_IMAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68903", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_EXPORT_TO_PUBLIC"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68902", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_VM_COST_CODE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68905", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_DOWNLOAD_FROM_REMOTE_REPOSITORY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68904", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_EXPORT_TO_PRIVATE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68907", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ENTERPRISE_ENUMERATE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68906", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ENTERPRISE_ADMINISTER_ALL"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68909", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ENTERPRISE_SHOW_STATS_LIMITS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68908", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ENTERPRISE_RESOURCE_SUMMARY_ENT"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68911", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "EVENTLOG_VIEW_ENTERPRISE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68910", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "EVENTLOG_VIEW_ALL"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68913", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_FIREWALLS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68912", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ASSIGN_FIREWALLS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68915", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_LOADBALANCERS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68914", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "ASSIGN_LOADBALANCERS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68917", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_HARD_DISKS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68916", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_FLOATINGIPS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68919", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ALLOW_MODIFY_ALLOCATION"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68918", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ALLOW_BACKUP_CONFIG"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68921", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ALLOW_MODIFY_SERVERS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68920", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ALLOW_MODIFY_NETWORK"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68923", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ENUMERATE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68922", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_ALLOW_MODIFY_STORAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68925", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_RETRIEVE_DETAILS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68924", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_MANAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68927", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PRICING_MANAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68926", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PHYS_DC_RETRIEVE_RESOURCE_USAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68929", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "SYSCONFIG_ALLOW_MODIFY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68928", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "PRICING_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68931", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "SYSCONFIG_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68930", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "SYSCONFIG_SHOW_REPORTS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68933", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_ENABLE_DISABLE_VM_METRICS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68932", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_DEFINE_AS_MANAGER"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68935", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_CHEF_ENTERPRISE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68934", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_ENUMERATE_CONNECTED"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68937", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_ENTERPRISE_BRANDING"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68936", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_ENTERPRISE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68939", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_RESERVED_MACHINES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68938", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_OTHER_ENTERPRISES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68941", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_ROLES_OTHER_ENTERPRISES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68940", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_ROLES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68943", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_SYSTEM_ROLES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68942", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_SCOPES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68945", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_PROHIBIT_VDC_RESTRICTION"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68944", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_USERS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68947", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68946", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_SHOW_VM_METRICS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68949", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_PUSH_VM_METRICS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68948", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VIEW_PRIVILEGES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68951", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_APPLICATIONS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68950", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_MANAGE_CREDENTIALS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68953", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VM_VIEW_ALARMS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68952", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_PROTECT_ACTION"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68955", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_EXCEED_CPU_RAM"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68954", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VM_MANAGE_ALARMS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68957", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_CHECK_USER_PASSWORD"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68956", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_EDIT_CPU_RAM"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68959", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_DETACH_NIC"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68958", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_ATTACH_NIC"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68961", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_CREATE_INSTANCE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68960", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_ISO"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68963", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_CUSTOMISE_SETTINGS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68962", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_CREATE_STATEFUL"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68965", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_DELETE_UNKNOWN_VM"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68964", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_DEFINE_BACKUP_INFO"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68967", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_MANAGE_BACKUP"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68966", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_DEPLOY_UNDEPLOY"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68969", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_MANAGE_LAYERS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68968", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_MANAGE_BACKUP_DISKS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68971", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_STATEFUL_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68970", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_PERFORM_ACTIONS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68973", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VAPP_VIEW_ALERTS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68972", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VAPP_RESTORE_BACKUP"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68975", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_ENUMERATE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68974", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "USERS_VAPP_MANAGE_ALERTS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68977", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE_NETWORK"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68976", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68979", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE_STORAGE_CONTROLLER"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68978", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE_STORAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68981", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_PUBLICIPS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68980", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE_VAPP"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68983", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_DEVICES"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68982", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "WORKFLOW_OVERRIDE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68985", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "CONSUME_VAPP_SPEC"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68984", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_VAPP_SPEC"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68987", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_ACTION_PLAN_VIEW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68986", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_ACTION_PLAN_MANAGE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68989", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "MANAGE_SCALING_GROUPS"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68988", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VM_RELOCATE"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68991", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "APPLIB_DISK_ALLOCATION"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68990", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "SCALING_GROUP_MANAGE_WORKFLOW"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68992", 
      "type": "application/vnd.abiquo.privilege+json", 
      "rel": "privilege", 
      "title": "VDC_MANAGE_STORAGE_DISK_ALLOCATION"
    }
  ]
}

List privileges of a role

Retrieves the list of privileges associated with a role.

Synopsis: GET http://example.com/api/admin/roles/{role}/action/privileges
Roles Required: AUTHENTICATED,USERS_VIEW_PRIVILEGES,USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.privileges+json; version=4.4; application/vnd.abiquo.privileges+xml; version=4.4;  Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity: Privileges Media Type
Request Example:

 Click here to show or hide the request example


GET_adm_roles_X_act_privs_AC_privs_j.txt

cURL:

curl -X GET http://localhost:9000/api/admin/roles/4/action/privileges \ 
	 -H 'Accept:application/vnd.abiquo.privileges+json; version=4.2' \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

--none--

Response payload:

{
    "links": [
        {
            "title": "PHYS_DC_RETRIEVE_DETAILS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/7"
        },
        {
            "title": "USERS_VIEW",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/30"
        },
        {
            "title": "VDC_ENUMERATE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/12"
        },
        {
            "title": "VAPP_CUSTOMISE_SETTINGS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/17"
        },
        {
            "title": "APPLIB_DOWNLOAD_IMAGE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/28"
        },
        {
            "title": "USERS_MANAGE_USERS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/32"
        },
        {
            "title": "APPLIB_UPLOAD_IMAGE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/26"
        },
        {
            "title": "VDC_MANAGE_VAPP",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/14"
        },
        {
            "title": "APPLIB_VIEW",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/24"
        },
        {
            "title": "ENTERPRISE_ADMINISTER_ALL",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/2"
        },
        {
            "title": "USERS_MANAGE_ENTERPRISE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/31"
        },
        {
            "title": "VDC_MANAGE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/13"
        },
        {
            "title": "PHYS_DC_ALLOW_MODIFY_SERVERS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/8"
        },
        {
            "title": "USERS_MANAGE_RESERVED_MACHINES",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/55"
        },
        {
            "title": "APPLIB_ALLOW_MODIFY",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/25"
        },
        {
            "title": "PHYS_DC_ALLOW_BACKUP_CONFIG",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/58"
        },
        {
            "title": "PHYS_DC_RETRIEVE_RESOURCE_USAGE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/5"
        },
        {
            "title": "PHYS_DC_ENUMERATE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/4"
        },
        {
            "title": "PHYS_DC_MANAGE",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/6"
        },
        {
            "title": "ENTERPRISE_RESOURCE_SUMMARY_ENT",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/3"
        },
        {
            "title": "MANAGE_FLOATINGIPS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/64"
        },
        {
            "title": "MANAGE_FIREWALLS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/66"
        },
        {
            "title": "VAPP_CREATE_STATEFUL",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/22"
        },
        {
            "title": "VAPP_DEPLOY_UNDEPLOY",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/18"
        },
        {
            "title": "VAPP_PERFORM_ACTIONS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/21"
        },
        {
            "title": "SYSCONFIG_VIEW",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/41"
        },
        {
            "title": "PRICING_VIEW",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/49"
        },
        {
            "title": "USERS_MANAGE_OTHER_ENTERPRISES",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/33"
        },
        {
            "title": "USERS_VIEW_PRIVILEGES",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/35"
        },
        {
            "title": "CONSUME_VAPP_SPEC",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/79"
        },
        {
            "title": "MANAGE_LOADBALANCERS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/70"
        },
        {
            "title": "USERS_PROHIBIT_VDC_RESTRICTION",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/34"
        },
        {
            "title": "VDC_MANAGE_STORAGE_CONTROLLER",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/85"
        },
        {
            "title": "VM_EDIT_CPU_RAM",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/87"
        },
        {
            "title": "USERS_VAPP_VIEW_ALERTS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/83"
        },
        {
            "title": "USERS_VM_VIEW_ALARMS",
            "rel": "privilege",
            "type": "application/vnd.abiquo.privilege+json",
            "href": "https://example.com:443/api/config/privileges/81"
        }
    ]
}


Update a role

Update information about an existing role. 

This method will replace ALL privileges currently assigned to the role with the privileges given in the data entity. Therefore, an empty data entity will result in a role with no privileges.

Synopsis: PUT http://example.com/api/admin/roles/{role}
Roles Required: USERS_MANAGE_ROLES
Request Headers: Accept: application/vnd.abiquo.role+json; version=4.4; application/vnd.abiquo.role+xml; version=4.4;  Content-type:  application/vnd.abiquo.role+json; version=4.4; application/vnd.abiquo.role+xml; version=4.4;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity: Role Media Type
Response Message Body Entity: Role Media Type
Request Example:

 Click here to show or hide the request example

PUT_adm_roles_X_CT_role_j_AC_role_j.0001.txt

cURL:

curl -X PUT http://localhost:9000/api/admin/roles/807 \ 
	 -H 'Accept:application/vnd.abiquo.role+json; version=4.2' \ 
	 -H 'Content-Type:application/vnd.abiquo.role+json; version=4.2' \ 
	 -d @requestpayload.json \ 
	 -u user:password --verbose 

Success status code: 200

Request payload:

{
  "id": 807, 
  "name": "name", 
  "externalRoles": [
    "ldap1", 
    "ldap2"
  ], 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles/807", 
      "type": "application/vnd.abiquo.role+json", 
      "rel": "edit", 
      "title": "20"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles/807/action/privileges", 
      "type": "application/vnd.abiquo.privileges+json", 
      "rel": "privileges", 
      "title": "privileges"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/1132", 
      "rel": "enterprise"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68893", 
      "rel": "privilege68893"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68894", 
      "rel": "privilege68894"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68895", 
      "rel": "privilege68895"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68896", 
      "rel": "privilege68896"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68897", 
      "rel": "privilege68897"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68898", 
      "rel": "privilege68898"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68899", 
      "rel": "privilege68899"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68900", 
      "rel": "privilege68900"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68901", 
      "rel": "privilege68901"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68902", 
      "rel": "privilege68902"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68903", 
      "rel": "privilege68903"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68904", 
      "rel": "privilege68904"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68905", 
      "rel": "privilege68905"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68906", 
      "rel": "privilege68906"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68907", 
      "rel": "privilege68907"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68908", 
      "rel": "privilege68908"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68909", 
      "rel": "privilege68909"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68910", 
      "rel": "privilege68910"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68911", 
      "rel": "privilege68911"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68912", 
      "rel": "privilege68912"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68913", 
      "rel": "privilege68913"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68914", 
      "rel": "privilege68914"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68915", 
      "rel": "privilege68915"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68916", 
      "rel": "privilege68916"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68917", 
      "rel": "privilege68917"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68918", 
      "rel": "privilege68918"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68919", 
      "rel": "privilege68919"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68920", 
      "rel": "privilege68920"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68921", 
      "rel": "privilege68921"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68922", 
      "rel": "privilege68922"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68923", 
      "rel": "privilege68923"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68924", 
      "rel": "privilege68924"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68925", 
      "rel": "privilege68925"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68926", 
      "rel": "privilege68926"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68927", 
      "rel": "privilege68927"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68928", 
      "rel": "privilege68928"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68929", 
      "rel": "privilege68929"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68930", 
      "rel": "privilege68930"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68931", 
      "rel": "privilege68931"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68932", 
      "rel": "privilege68932"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68933", 
      "rel": "privilege68933"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68934", 
      "rel": "privilege68934"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68935", 
      "rel": "privilege68935"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68936", 
      "rel": "privilege68936"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68937", 
      "rel": "privilege68937"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68938", 
      "rel": "privilege68938"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68939", 
      "rel": "privilege68939"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68940", 
      "rel": "privilege68940"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68941", 
      "rel": "privilege68941"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68942", 
      "rel": "privilege68942"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68943", 
      "rel": "privilege68943"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68944", 
      "rel": "privilege68944"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68945", 
      "rel": "privilege68945"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68946", 
      "rel": "privilege68946"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68947", 
      "rel": "privilege68947"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68948", 
      "rel": "privilege68948"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68949", 
      "rel": "privilege68949"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68950", 
      "rel": "privilege68950"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68951", 
      "rel": "privilege68951"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68952", 
      "rel": "privilege68952"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68953", 
      "rel": "privilege68953"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68954", 
      "rel": "privilege68954"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68955", 
      "rel": "privilege68955"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68956", 
      "rel": "privilege68956"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68957", 
      "rel": "privilege68957"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68958", 
      "rel": "privilege68958"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68959", 
      "rel": "privilege68959"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68960", 
      "rel": "privilege68960"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68961", 
      "rel": "privilege68961"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68962", 
      "rel": "privilege68962"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68963", 
      "rel": "privilege68963"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68964", 
      "rel": "privilege68964"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68965", 
      "rel": "privilege68965"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68966", 
      "rel": "privilege68966"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68967", 
      "rel": "privilege68967"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68968", 
      "rel": "privilege68968"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68969", 
      "rel": "privilege68969"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68970", 
      "rel": "privilege68970"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68971", 
      "rel": "privilege68971"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68972", 
      "rel": "privilege68972"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68973", 
      "rel": "privilege68973"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68974", 
      "rel": "privilege68974"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68975", 
      "rel": "privilege68975"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68976", 
      "rel": "privilege68976"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68977", 
      "rel": "privilege68977"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68978", 
      "rel": "privilege68978"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68979", 
      "rel": "privilege68979"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68980", 
      "rel": "privilege68980"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68981", 
      "rel": "privilege68981"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68982", 
      "rel": "privilege68982"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68983", 
      "rel": "privilege68983"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68984", 
      "rel": "privilege68984"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68985", 
      "rel": "privilege68985"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68986", 
      "rel": "privilege68986"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68987", 
      "rel": "privilege68987"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68988", 
      "rel": "privilege68988"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68989", 
      "rel": "privilege68989"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68990", 
      "rel": "privilege68990"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68991", 
      "rel": "privilege68991"
    }, 
    {
      "href": "http://localhost:9009/api/config/privileges/68992", 
      "rel": "privilege68992"
    }
  ], 
  "blocked": false
}

Response payload:

{
  "idEnterprise": 1132, 
  "name": "name", 
  "links": [
    {
      "href": "http://localhost:9009/api/admin/roles/807", 
      "type": "application/vnd.abiquo.role+json", 
      "rel": "edit", 
      "title": "name"
    }, 
    {
      "href": "http://localhost:9009/api/admin/enterprises/1132", 
      "type": "application/vnd.abiquo.enterprise+json", 
      "rel": "enterprise", 
      "title": "21"
    }, 
    {
      "href": "http://localhost:9009/api/admin/roles/807/action/privileges", 
      "type": "application/vnd.abiquo.privileges+json", 
      "rel": "privileges", 
      "title": "privileges"
    }
  ], 
  "blocked": false, 
  "id": 807, 
  "externalRoles": [
    "ldap1", 
    "ldap2"
  ]
}

 

Delete a role

Delete a role

Synopsis: DELETE http://example.com/api/admin/roles/{role}
Roles Required: USERS_MANAGE_ROLES
Request Headers: Accept: ; Content-type: ;
Request Parameters:

Parameter

Required

Default Value

Description

 

 

 

 

Request Message Body Entity:
Response Message Body Entity:
Request Example:

 Click here to show or hide the request example

DELETE_adm_roles_X.0001.txt

cURL:

curl -X DELETE http://localhost:9000/api/admin/roles/822 \ 
	 -H 'Accept:text/json,application/json' \ 
	 -u user:password --verbose 

Success status code: 204

Request payload:

--none--

Response payload:

--none--