Arlo

REST Auth API: ContactSecurityRoles

ContactSecurityRoles resources are a subresource of ContactSecurity, and list the roles of the parent Contact resource.

ContactSecurityRoles resource

Resource URI

/{platform_name}/api/2012-02-01/auth/resources/contacts/{ContactID}/security/roles

General structure

<Roles>
  <Role>Administrator</Role>
  <Role>API User</Role>
  <Role>Presenter</Role>
</Roles>

Resource properties

Property Description
Role A repeating element containing the roles of the parent Contact resource. The element can have the values API User, Administrator or Presenter.

HTTP GET

Returns a representation of a ContactSecurityRoles resource, including the properties and links above.

Example

GET /demo/api/2012-02-01/auth/resources/contacts/562/security/roles

<Roles>
  <Role>Administrator</Role>
  <Role>API User</Role>
  <Role>Presenter</Role>
</Roles>

HTTP POST

Not directly supported, this resource can be created in a POST for a Contact Resource. Only the Presenter role may be specified in a POST.

HTTP PUT

Not directly supported, this resource can be updated via a PUT for the parent Contact Resource. Only the Presenter role may be added or removed by a PUT.

HTTP PATCH

Not directly supported, this resource can be updated via a PATCH for the parent Contact Resource. Only the Presenter role may be added or removed by a PATCH.

HTTP DELETE

Not supported.