ジャンプ先

• リクエスト
• レスポンス
• 例

ロール終了日付へのパッチ適用

patch

/iam/governance/selfservice/api/v1/roles/{roleid}/members

指定されたロールのendDateで1人以上のユーザーを更新します。ログイン・ユーザーは、変更アクションの実行に必要な権限を持っている必要があります。

リクエスト

サポートされているメディア・タイプ

• application/json

パス・パラメータ

• roleid: string
  エンティティ・タイプ(RoleIDに指定可能な値)

本文()

更新するユーザーのロール終了日付。

ルート・スキーマ: RoleEndDatePatchRequest

型: object

ソースを表示

• update(optional): array update

{
    "properties":{
        "update":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/UpdateRoleEndDateRequest"
            }
        }
    }
}

ネストされたスキーマ: update

型: array

ソースを表示

• 配列: オブジェクト UpdateRoleEndDateRequest

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/UpdateRoleEndDateRequest"
    }
}

ネストされたスキーマ: UpdateRoleEndDateRequest

型: object

ソースを表示

• endDate(optional): string
• userId(optional): string

{
    "properties":{
        "userId":{
            "type":"string"
        },
        "endDate":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

サポートされているメディア・タイプ

• application/json

200レスポンス

成功

ヘッダー

• ResponseTime: string
  リクエストの処理にかかった時間(ミリ秒)を取得します。

本文()

ルート・スキーマ: RoleEndDatePatchResponse

型: object

ソースを表示

• links(optional): array links
• status(optional): string

{
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/LinkDataInstances"
            }
        },
        "status":{
            "type":"string"
        }
    }
}

ネストされたスキーマ: links

型: array

ソースを表示

• 配列: オブジェクト LinkDataInstances

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/LinkDataInstances"
    }
}

ネストされたスキーマ: LinkDataInstances

型: object

ソースを表示

• href(optional): string
• rel(optional): string

{
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        }
    }
}

401レスポンス

未認可

404レスポンス

リクエスト・エンティティが見つからない

500レスポンス

内部サーバー・エラー

先頭に戻る

例

cURLの例

この例では、1つのリクエストで複数のユーザーにパッチを適用する機能を示します。ここに示す情報は、擬似システムを使用した場合のものであり、プロトタイプとして提供しています。

curl  -H "Content-Type: application/json"  -H "X-Requested-By: <anyvalue>"  -X PATCH  -u username:password  -d @patch.json https://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members

PATCHリクエスト本文の例

次の例に、JSON形式のリクエスト本文のコンテンツを示します。

{
   	"update" : [
        	{
   		  "userId": "82",
    		  "endDate": "2022-07-20T12:12:12Z"
        	 }
   	]
 }

PATCHレスポンス本文の例

JSON形式のレスポンス本文のコンテンツの例を次に示します。

{
    "links": [
        {
            "rel": "self",
            "href": "https://pseudo.com/iam/governance/selfservice/api/v1/roles/8/members"
        }
    ],
    "status": "SUCCESS"
}

先頭に戻る