LIST API

This page describes the K2HR3 LIST API. The purpose of the LIST API is to list available K2HR3 SERVICEs, K2HR3 RESOURCEs, K2HR3 ROLEs and K2HR3 POLICIes. Each element is in YRN form. See the Service Usage for the K2HR3 SERVICEs, K2HR3 RESOURCEs, K2HR3 ROLEs and K2HR3 POLICIes.

GET

Lists a list of the followings in YRN form. A scoped user token is required, so that these lists are scoped to the user identified by the token.

• SERVICE
  • a list of SERVICEs that the tenant is allowed access to
• RESOURCE
  • a list of RESOURCEs that belong to the tenant
• POLICY
  • a list of POLICYs that belong to the tenant
• ROLE
  • a list of ROLEs that belong to the tenant

Endpoint(URL)

http(s)://API SERVER:PORT/v1/list/service name
http(s)://API SERVER:PORT/v1/list{/service name}/resource{/root path}?urlarg
http(s)://API SERVER:PORT/v1/list{/service name}/policy{/root path}?urlarg
http(s)://API SERVER:PORT/v1/list{/service name}/role{/root path}?urlarg

Header

Content-Type: application/json
x-auth-token: U=<Scoped User Token>

URL Arguments

• expand=true or false(default)
  • False will obtain an array of objects of the first children of the root YRN object
  • True will obtain an array of objects of all children of the root YRN object

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    children:   [
        {
            name:        <path name>
            children:    [
                {
                    ...
                },
                ...
            ]
        },
        ...
    ]
}

• result
  True if success. False otherwise
• message
  An error message if the result is false
• children
  • An array of objects of the first children of the root YRN object if querying with ‘expand=false’(this is the default dehavior)
  • An array of objects of all children of the root YRN object if querying with ‘expand=true’

HEAD

Validates that the each root YRN object of SERVICE, RESOURCE, POLICY and ROLE of scoped tenant exists

Endpoint(URL)

http(s)://API SERVER:PORT/v1/list/service name
http(s)://API SERVER:PORT/v1/list{/service name}/resource{/root path}?urlarg
http(s)://API SERVER:PORT/v1/list{/service name}/resource{/root path}?urlarg
http(s)://API SERVER:PORT/v1/list{/service name}/policy{/root path}?urlarg
http(s)://API SERVER:PORT/v1/list{/service name}/role{/root path}?urlarg

Header

Content-Type: application/json
x-auth-token: U=<Scoped User Token>

Response status

204、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
}

• result
  True if success. False otherwise
• message
  An error message if the result is false