POLICY API REST API ACR API

SERVICE API

K2HR3 REST APIのサービス(SERVICE)に関連するAPI群です。

POST

Scoped User Tokenを指定して、サービス(SERVICE)を作成します。
もしくは、既存サービス(SERVICE)の利用側(MEMBER)のテナント(TENANT)の追加、VERIFY URLの更新を行います。
Scoped User Tokenは、サービス(SERVICE)の所有側(OWNER)のテナント(TENANT)にアクセス権限のあるユーザ(USER)を指定します。 サービス(SERVICE)新規作成時は、指定されたのScoped User Tokenのテナント(TENANT)が所有側(OWNER)になります。

Endpoint(URL)

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

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

Request Body

サービス(SERVICE)作成時

{
    "name":    <service name>
    "verify":  <verify url>
}

利用側(MEMBER)のテナント(TENANT)追加/VERIFY URL更新時

{
    "tenant":  <tenant name> or [<tenant name>, ...]
    "clear_tenant": true/false or undefined
    "verify":  <verify url>
}

Response status

201、40x

Response Body(JSON)

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

PUT

Scoped User Tokenを指定して、サービス(SERVICE)を作成します。
もしくは、既存サービス(SERVICE)の利用側(MEMBER)のテナント(TENANT)の追加、VERIFY URLの更新を行います。
Scoped User Tokenは、サービス(SERVICE)の所有側側(OWNER)のテナント(TENANT)にアクセス権限のあるユーザ(USER)を指定します。 サービス(SERVICE)新規作成時は、指定されたのScoped User Tokenのテナント(TENANT)が所有側(OWNER)になります。

Endpoint(URL)

新規作成時

http(s)://API SERVER:PORT/v1/service?name=service name&verify=verify url

利用側(MEMBER)のテナント(TENANT)追加時

http(s)://API SERVER:PORT/v1/service/service name?tenant=tenant name

VERIFY URL更新時

http(s)://API SERVER:PORT/v1/service/service name?_verify=verify url

Header

x-auth-token: U=<Scoped User Token>

URL Arguments

新規作成時

利用側(MEMBER)のテナント(TENANT)追加時

VERIFY URL更新時

Response status

201、40x

Response Body(JSON)

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

GET

サービス(SERVICE)に設定された情報を取得します。 サービス(SERVICE)の所有側側(OWNER)のテナント(TENANT)に属するScoped User Tokenを指定します。

Endpoint(URL)

http(s)://API SERVER:PORT/v1/service/service name

Header

Scoped User Token指定

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

Response status

200、40x

Response Body(JSON)

{
    result:     <true/false>
    message:    <null or error message string>
    service:    {
        verify:     <verify url> or <static string> or <false>
        tenant:	[
            <tenant yrn full path>,
            ...
        ]
    }
}

サービス(SERVICE)の存在確認、もしくはサービス(SERVICE)の利用側(MEMBER)のテナント(TENANT)の確認をします。
サービス(SERVICE)の所有側(OWNER)のテナント(TENANT)に属するScoped User Tokenを指定します。

Endpoint(URL)

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

Header

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

URL Arguments

利用側(MEMBER)のテナント(TENANT)確認時

Response status

204、40x

Response Body(JSON)

なし

DELETE

サービス(SERVICE)の削除、もしくはサービス(SERVICE)の利用側(MEMBER)のテナント(TENANT)の削除をします。
サービス(SERVICE)の所有側(OWNER)のテナント(TENANT)に属するScoped User Tokenを指定します。

Endpoint(URL)

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

Header

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

URL Arguments

利用側(MEMBER)のテナント(TENANT)削除時

Response status

204、40x

Response Body(JSON)

なし

POLICY API REST API ACR API