Menu

Lumen help

Access group hierarchy

Description

Default call: returns hierarchical representation of the access group associated with the calling API key.

Typical use

To determine part of the scope for any API call. Lists every access group and child access group that is assigned to the user.

Method

GET

Schema location

https://ws.lumen.com/schema/accessGroups/v1.0

Base URI

https://ws.lumen.com

URI syntax (scope)

/accessGroups/(version)

accessGroups—returns list of access groups within this key.

version—required version.

Example

https://ws.lumen.com/accessGroups/v1.0

<?xml version="1.0" encoding="UTF-8"?>

<accessGroup id="12345" name="My Access Group" xsi:noNamespaceSchemaLocation= “(Undefined variable: Primary.API Schema URI)/accessGroups/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<apiCorrelationId>CDNPortal-1270071184562- 8650</apiCorrelationId>

<serviceResource>/12345</serviceResource>

<description>AG description</description>

<createdDate>2010-01-22 01:23 -0700</createdDate>

<modifiedDate>2010-01-22 01:23 -0700</modifiedDate>

<createdUser>user@domain.com</createdUser>

<modifiedUser>user@domain.com</modifiedUser>

<domainId>894</domainId>

<parentId>894</parentId>

<accessGroups>

<accessGroup .../>

</accessGroups>

</accessGroup>

Possible status and error messages returned to client