REL documentation
master apirole (http://api.3plcentral.com/rels/master/apirole)
Resource:
an api role together with the set of policies defining the access rights of an ApiCredential assigned such role
C# Rel Const:
Rels.MasterSvc.ApiRole
URI template:
api/roles/{role}
Obtain URI from:
Get an api role.
Success status: 200
Name (* = required) Data Type Description
role * string
Type Description
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Links IList<WebApi.Hal.Link>
- edit If Link.Name contains 'Disallow: ' with DELETE in the list, then policies for this role cannot be deleted because it is in use.
Sample accept: application/hal+json
{
  "role": "str",
  "policies": [
    {
      "service": "str",
      "resource": "str",
      "httpMethods": [
        "str"
      ],
      "unauthorized": true
    }
  ]
}
Create or update the api policies applicable to 'role'.
Success status: 200
Name (* = required) Data Type Description
role * string
Type Description
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Sample content-type: application/hal+json
 
{
  "role": "str",
  "policies": [
    {
      "service": "str",
      "resource": "str",
      "httpMethods": [
        "str"
      ],
      "unauthorized": true
    }
  ]
}
Type Description
Role string
Policies IEnumerable<Master.Models.ApiPolicy>
Service string valid service name or * (meaning all services)
Resource string valid resource name or * (meaning all resources)
HttpMethods IEnumerable<string> Valid values : GET, PUT, POST, DELETE, * (meaning all HTTP verbs)
Unauthorized bool
Links IList<WebApi.Hal.Link>
- edit If Link.Name contains 'Disallow: ' with DELETE in the list, then policies for this role cannot be deleted because it is in use.
Sample accept: application/hal+json
{
  "role": "str",
  "policies": [
    {
      "service": "str",
      "resource": "str",
      "httpMethods": [
        "str"
      ],
      "unauthorized": true
    }
  ]
}
Delete the api policies applicable to 'role'.
Success status: 204
Name (* = required) Data Type Description
role * string

This documentation is subject to change, and is updated often and without warning. The models documented may or may not be available to users now or in the future. Use this documentation at your own risk.
Contact api@3plcentral.com with any questions about this documentation.