RolesLDAPResource

Roles Ldap Resource

Roles Resource offers the functionality of managing the platform roles in a logical way.

Main URI of the Resource

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

Exposed Methods

Get Roles Ldap

Retrieve all LDAP roles if the enterprise is not specified.

Paging Method

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

Synopsis: GET http://example.com/api/admin/rolesldap
Roles Required: ROLE_USERS_MANAGE_LDAP_GROUP,ROLE_USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.rolesldap+json; version=3.1; application/vnd.abiquo.rolesldap+xml; version=3.1; Content-type: ;
Request Parameters:

Parameter	Required	Default Value	Description
idRole	false		identifier of the role
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: RolesLdap Media Type
Request Example:

Click here to show or hide the request example

Get Roles Ldap example

curl --verbose -X GET -u user:password 'http://example.com/api/admin/rolesldap'
< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/vnd.abiquo.roleldap+xml;version=2.6
<roles>
    <link href="http://example.com/api/admin/rolesldap" rel="first"/>
    <link href="http://example.com/api/admin/rolesldap?startwith=0" rel="last"/>
    <totalSize>2</totalSize>
    <role>
        <link href="http://example.com/api/admin/rolesldap/7" rel="edit"/>
        <link href="http://example.com/api/admin/roles/11" rel="role"/>
        <id>7</id>
        <roleLdap>new role Ldap</roleLdap>
    </role>
    <role>
        <link href="http://example.com/api/admin/rolesldap/8" rel="edit"/>
        <link href="http://example.com/api/admin/roles/3" rel="role"/>
        <id>8</id>
        <roleLdap>role Ldap</roleLdap>
    </role>
</roles>

Create Role Ldap

Create a new LDAP role.

Synopsis: POST http://example.com/api/admin/rolesldap
Roles Required: ROLE_USERS_MANAGE_LDAP_GROUP
Request Headers: Accept: application/vnd.abiquo.roleldap+json; version=3.1; application/vnd.abiquo.roleldap+xml; version=3.1; Content-type: application/vnd.abiquo.roleldap+json; version=3.1; application/vnd.abiquo.roleldap+xml; version=3.1;
Request Parameters:

Parameter	Required	Default Value	Description

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

Click here to show or hide the request example

Create Role Ldap example

curl --verbose 'http://example.com/api/admin/rolesldap' \
      -X "POST" \
      -H "Content-type:application/vnd.abiquo.roleldap+xml;version=2.6" \
      -H "Accept: application/vnd.abiquo.roleldap+xml;version=2.6" \
      -d @entity.xml
      -u user:password 

> POST /api/admin/roles HTTP/1.1
> User-Agent: curl/7.19.5 (i486-pc-linux-gnu) libcurl/7.19.5 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.15
> Host: example.com
> Content-type:application/vnd.abiquo.roleldap+xml;version=2.6
> Accept:application/vnd.abiquo.roleldap+xml;version=2.6
> Content-Length: **

< HTTP/1.1 201 Created
< Server: Apache-Coyote/1.1
< Content-Type:application/vnd.abiquo.roleldap+xml;version=2.6
< Content-Length: **
<

<roleLdap>
    <link href="http://example.com/api/admin/rolesldap/7" rel="edit"/>
    <link href="http://example.com/api/admin/roles/11" rel="role"/>
    <id>7</id>
    <roleLdap>new role Ldap</roleLdap>
</roleLdap>

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Get Role Ldap

Retrieve information of an LDAP role.

Synopsis: GET http://example.com/api/admin/rolesldap/{roleldap}
Roles Required: ROLE_USERS_MANAGE_LDAP_GROUP,ROLE_USERS_VIEW
Request Headers: Accept: application/vnd.abiquo.roleldap+json; version=3.1; application/vnd.abiquo.roleldap+xml; version=3.1; Content-type: ;
Request Parameters:

Parameter	Required	Default Value	Description

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

Click here to show or hide the request example

Get Role Ldap example

curl --verbose -u user:password 'http://example.com/api/admin/rolesldap/7' \
        -X "GET" \
        -H "Content-type:application/vnd.abiquo.roleldap+xml;version=2.6" \
        -H "Accept:application/vnd.abiquo.roleldap+xml;version=2.6"

> GET /api/admin/roles/2 HTTP/1.1
> User-Agent: curl/7.19.5 (i486-pc-linux-gnu) libcurl/7.19.5 OpenSSL/0.9.8g zlib/1.2.3.3 libidn/1.15
> Host: example.com
> Accept:application/vnd.abiquo.roleldap+xml;version=2.6"

< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/vnd.abiquo.roleldap+xml;version=2.6"
< Content-Length: *

<roleLdap>
    <link href="http://example.com/api/admin/rolesldap/7" rel="edit"/>
    <link href="http://example.com/api/admin/roles/11" rel="role"/>
    <id>7</id>
    <roleLdap>new role Ldap</roleLdap>
</roleLdap>

Update Role Ldap

Update an LDAP role.

Synopsis: PUT http://example.com/api/admin/rolesldap/{roleldap}
Roles Required: ROLE_USERS_MANAGE_LDAP_GROUP
Request Headers: Accept: application/vnd.abiquo.roleldap+json; version=3.1; application/vnd.abiquo.roleldap+xml; version=3.1; Content-type: application/vnd.abiquo.roleldap+json; version=3.1; application/vnd.abiquo.roleldap+xml; version=3.1;
Request Parameters:

Parameter	Required	Default Value	Description

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

Click here to show or hide the request example

Update Role Ldap example

curl --verbose 'http://example.com/api/admin/rolesldap/7' \
        -X "PUT" \
        -H "Content-type: application/vnd.abiquo.roleldap+xml;version=2.6" \
        -H "Accept: application/vnd.abiquo.roleldap+xml;version=2.6" \
        -d @entity.xml \
	    -u user:password 


> PUT /api/admin/roles/3 HTTP/1.1
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com
> Content-type: application/vnd.abiquo.roleldap+xml;version=2.6
> Accept: application/vnd.abiquo.roleldap+xml;version=2.6
> Content-Length: **

< HTTP/1.1 200 OK
< Server: Apache-Coyote/1.1
< Content-Type: application/vnd.abiquo.roleldap+xml;version=2.6
< Content-Length: 0
<roleLdap>
    <link href="http://example.com/api/admin/rolesldap/7" rel="edit"/>
    <link href="http://example.com/api/admin/roles/11" rel="role"/>
    <id>7</id>
    <roleLdap>new role Ldap updated</roleLdap>
</roleLdap>

Download a template

You can download the template of the entity here (click right mouse button and 'Save Link As..')

Delete Role Ldap

Delete information of an LDAP role.

Synopsis: DELETE http://example.com/api/admin/rolesldap/{roleldap}
Roles Required: ROLE_USERS_MANAGE_LDAP_GROUP
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 Role Ldap example

curl --verbose -X DELETE -u user:password  'http://example.com/api/admin/rolesldap/8'

> DELETE /api/admin/rolesldap/3 HTTP/1.1
> User-Agent: curl/7.21.0 (x86_64-pc-linux-gnu) libcurl/7.21.0 OpenSSL/0.9.8o zlib/1.2.3.4 libidn/1.18
> Host: example.com

Space shortcuts

RolesLDAPResource