Documentation
Roles Resource offers the functionality of managing the platform roles in a logical way.
This class operates mainly over the Resource URI: /admin/rolesldap
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 |
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:
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:
Download a template
You can download the template of the entity here (click right mouse button and 'Save Link As..')
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:
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:
Download a template
You can download the template of the entity here (click right mouse button and 'Save Link As..')
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: