LIST API

K2HR3 REST APIのLISTに関連するAPI群です。

GET

Scoped User Tokenを指定し、Scopeされているテナント（TENANT）のサービス（SERVICE）リスト、またはリソース（RESOURCE）、ポリシー/ルール（POLICY）、ロール（ROLE）いずれかのYRNパスを取得します。
テナント（TENANT）がアクセスできるサービス（SERVICE）のリストを取得するAPIです。
もしくは、テナント（TENANT）に設定されているRESOURCE名、ポリシー/ルール（POLICY）名、ロール（ROLE）名を取得するAPIです。
取得時にルートとなるリソース（RESOURCE）、ポリシー/ルール（POLICY）、ロール（ROLE）のYRNパスを指定し、その下位層のYRNパスのリストを取得できます。
また、ルートYRNパス以下の階層化されたYRNパスを一度に取得することもできます。

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>

URL Arguments

• expand=true or false
  階層化されたYRNパスを一度に取得する場合にはtrueを指定します。省略された場合にはfalseとして動作します。

Response status

200、40x

Response Body(JSON)

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

• result
  APIの処理結果をtrue/falseで返します。
• message
  処理結果がfalse（失敗）のときに、エラーメッセージが格納されます。
• children
  指定されたルートYRNパス直下にあるYRNパス名のリストをオブジェクト配列で返します。
  expand=falseの場合には、第一階層のみが返されます。
  expand=trueの場合には、各階層ごとにYRNパス名とchildren配列としてツリー構成のリストが返されます。

HEAD

Scoped User Tokenを指定し、Scopeされているテナント（TENANT）のサービス（SERVICE）、リソース（RESOURCE）、ポリシー/ルール（POLICY）、ロール（ROLE）のYRNパスも指定し、アクセスが可能であるか確認します。

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
  APIの処理結果をtrue/falseで返します。
• message
  処理結果がfalse（失敗）のときに、エラーメッセージが格納されます。