RESOURCE API REST API SERVICE API

POLICY API

K2HR3 REST APIのポリシー/ルール(POLICY)に関連するAPI群です。

POST

Scoped User Tokenを指定して、リソース(RESOURCE)の情報を設定(新規作成、更新)します。
Role Tokenを指定して、リソース(RESOURCE)の情報を設定(更新)します。
Token未指定で、リソース(RESOURCE)の情報を設定(更新)します。
Scoped User Tokenの場合に限り、エリアス(ALIAS)の設定ができます。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/policy

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

Request Body

{
    policy:    {
        name:      <policy name>
        effect:    <allow or deny>
        action:    [<action yrn full path>,...]
        resource:  [<resource yrn full path>,...]
        condition: null or undefined
        alias:     [<policy yrn full path>,...]
    }
}

Response status

201、40x

Response Body(JSON)

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

PUT

Scoped User Tokenを指定して、リソース(RESOURCE)の情報を設定(新規作成、更新)します。
Role Tokenを指定して、リソース(RESOURCE)の情報を設定(更新)します。
Token未指定で、リソース(RESOURCE)の情報を設定(更新)します。
Scoped User Tokenの場合に限り、エリアス(ALIAS)の設定ができます。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/policy?urlarg

Header

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

URL Arguments

Response status

201、40x

Response Body(JSON)

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

GET

ポリシー/ルール(POLICY)のデータを取得するためのAPIです。
サービス(SERVICE)が指定された場合には、サービス(SERVICE)とテナント(TENANT)で示されるYRNパス以下のポリシー/ルール(POLICY)の情報が返されます。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/policy/policy path or yrn full policy path{?service=service name}

Header

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

URL argument

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    policy:    {
        name:       <policy name>,
        effect:     <allow or deny>,
        action:     [<action yrn full path>, ...],
        resource:   [<resource yrn full path>, ...],
        alias:      [<policy yrn full path>, ...]
    }
}

ポリシー/ルール(POLICY)の内容を確認するためのAPIです。
テナント(TENANT)名とリソース(RESOURCE)の(YRNフルパス)を指定して、特定のアクセス方法(ACTION)が実行できるか確認します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/policy/yrn full policy path?urlarg

Header

Content-Type: application/json

URL Arguments

Response status

204、40x

Response Body(JSON)

なし

DELETE

ポリシー/ルール(POLICY)を削除します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/policy/policy path or yrn full policy path

Header

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

Response status

204、40x

Response Body(JSON)

なし

RESOURCE API REST API SERVICE API