機械翻訳について

移動先

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

すべてのアカウントのリストを取得

get

/access-governance/identities/20250331/identities/{identityId}/accounts

取引先のリストを返します。 ノート・キーワード検索は、名前フィールドおよび最初のキーワード問合せパラメータに制限されます。

リクエスト

パス・パラメータ

• identityId(required): string
  一意のアイデンティティID。

問合せパラメータ

• keywordContains: array[string]
  コレクション形式: multi

  最大アイテム数: 5

  フィルタするキーワードのリスト
• limit: integer
  最小値: 1

  最大値: 1000

  返されるアイテムの最大数。

  デフォルト値: 10
• page: string
  最小長: 1

  結果の取得を開始する位置を表すトークン。 これは、前のレスポンスの`opc-next-page`ヘッダー・フィールドから取得する必要があります。
• sortBy: string
  ソートの基準となるフィールド。 指定できるソート順は1つのみです。 timeCreatedのデフォルトの順序は降順です。 displayNameのデフォルトの順序は昇順です。

  デフォルト値: timeCreated

  許容値: [ "timeCreated", "displayName" ]
• sortOrder: string
  使用するソート順(ASCまたはDESC)。

  許容値: [ "ASC", "DESC" ]

ヘッダー・パラメータ

• opc-request-id: string
  トレース用のクライアント・リクエストID。 リクエストIDに有効な文字は、文字、数字、アンダースコアおよびダッシュのみです。

トップに戻る

レスポンス

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

• application/json

200レスポンス

Accountオブジェクトのリスト。

ヘッダー

• opc-next-page: string
  アイテム・リストのページ区切り。 リストをページングする際、このヘッダーがレスポンスに表示される場合は、部分的なリストが返されている可能性があります。 この値を後続のGETリクエストの`page`パラメータとして含め、次のアイテム・バッチを取得します。
• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : AccountCollection

型: object

口座リスト

ソースを表示

• items(必須): array items
  口座リスト

{
    "type":"object",
    "required":[
        "items"
    ],
    "properties":{
        "items":{
            "type":"array",
            "description":"List of Accounts.",
            "items":{
                "$ref":"#/definitions/AccountSummary"
            }
        }
    },
    "description":"List of Accounts."
}

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

型: array

口座リスト

ソースを表示

• Array of: object AccountSummary
  アカウントのサマリー。

{
    "type":"array",
    "description":"List of Accounts.",
    "items":{
        "$ref":"#/definitions/AccountSummary"
    }
}

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

型: object

アカウントのサマリー。

ソースを表示

• accountStatus: string
  許容値: [ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ]

  アカウントのステータス。
• canDelete: boolean
  アカウントの削除機能を示すフラグ。
• canDisable: boolean
  アカウントの無効化機能を示すフラグ。
• grantType: string
  アカウントの付与タイプ。
• id(必須): string
  アカウント所有者のグローバル・アイデンティティ。
• isPmProvisioned: boolean
  PMによってプロビジョニングされたかどうかを示します。
• isPolicyGrant: boolean
  アカウントがポリシーに関連付けられているかどうかを示します。
• name: string
  アカウント所有者の名前
• orchestratedSystem: object Info
  汎用情報オブジェクト。
• orchestratedSystemIdentityId: string
  アカウント所有者のオーケストレート済システム・アイデンティティ。
• orchestratedSystemType: string
  オーケストレーション済システムのタイプ。
• passwordChangeStatus: string
  パスワード変更ステータス
• resourceName: string
  リソースの名前
• risk: string
  インサイト予測値。
• state: string
  許容値: [ "ENABLED", "DISABLED", "ENABLE_IN_PROGRESS", "DISABLE_IN_PROGRESS", "DELETE_IN_PROGRESS", "ENABLE_FAILED", "DISABLE_FAILED", "DELETE_FAILED" ]

  最後の処理イベントの状態。
• timeUpdated: string(date-time)
  アカウントが更新された時間。 RFC3339形式の日時文字列

{
    "type":"object",
    "required":[
        "id"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Global Identity id of the account owner."
        },
        "name":{
            "type":"string",
            "description":"Name of the account owner."
        },
        "passwordChangeStatus":{
            "type":"string",
            "description":"Password change status."
        },
        "isPmProvisioned":{
            "type":"boolean",
            "description":"Indicates if provisioned by PM."
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"The time the Account was updated. An RFC3339 formatted datetime string."
        },
        "resourceName":{
            "type":"string",
            "description":"Name of the Resource."
        },
        "orchestratedSystemIdentityId":{
            "type":"string",
            "description":"Orchestrated system Identity Id of the account owner."
        },
        "grantType":{
            "type":"string",
            "description":"Grant Type of the Account."
        },
        "orchestratedSystemType":{
            "type":"string",
            "description":"Type of the Orchestrated System."
        },
        "risk":{
            "type":"string",
            "description":"Insights prediction value."
        },
        "isPolicyGrant":{
            "type":"boolean",
            "description":"Indicates if the account is associated with any Policy."
        },
        "accountStatus":{
            "type":"string",
            "description":"Status of the Account.",
            "enum":[
                "ENABLED",
                "DISABLED",
                "ENABLE_IN_PROGRESS",
                "DISABLE_IN_PROGRESS",
                "DELETE_IN_PROGRESS",
                "ENABLE_FAILED",
                "DISABLE_FAILED",
                "DELETE_FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccountStatus",
            "x-default-description":"DISABLED"
        },
        "canDisable":{
            "type":"boolean",
            "description":"Flag to show the disabling capability of the account."
        },
        "canDelete":{
            "type":"boolean",
            "description":"Flag to show the deleting capability of the account."
        },
        "state":{
            "type":"string",
            "description":"State of the last processing event.",
            "enum":[
                "ENABLED",
                "DISABLED",
                "ENABLE_IN_PROGRESS",
                "DISABLE_IN_PROGRESS",
                "DELETE_IN_PROGRESS",
                "ENABLE_FAILED",
                "DISABLE_FAILED",
                "DELETE_FAILED"
            ],
            "x-obmcs-top-level-enum":"#/definitions/AccountStatus",
            "x-default-description":"DISABLED"
        },
        "orchestratedSystem":{
            "$ref":"#/definitions/Info"
        }
    },
    "description":"Summary of the Account."
}

ネストされたスキーマ : 情報

型: object

汎用情報オブジェクト。

ソースを表示

• displayName: string
  エンティティの表示名。
• id: string
  エンティティのID。
• name: string
  エンティティの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the entity."
        },
        "name":{
            "type":"string",
            "description":"name of the entity."
        },
        "displayName":{
            "type":"string",
            "description":"Display Name of the entity."
        }
    },
    "description":"Generic information object."
}

400レスポンス

不正なリクエスト

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

401レスポンス

未認可

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

404レスポンス

見つかりません

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

429レスポンス

リクエストが多すぎます

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

500レスポンス

内部サーバー・エラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

デフォルト・レスポンス

不明なエラー

ヘッダー

• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : Error

型: object

エラー情報。

ソースを表示

• code(必須): string
  プログラム解析用のエラーを定義する短いエラー・コード。
• message(必須): string
  判読可能なエラー文字列。

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"A short error code that defines the error, meant for programmatic parsing."
        },
        "message":{
            "type":"string",
            "description":"A human-readable error string."
        }
    },
    "description":"Error Information."
}

トップに戻る

例

次の例は、GETリクエストを発行してアカウントのリストを取得する方法を示しています。

cURL例 - 問合せパラメータなし

curl -i -X \
 GET \
 -H \
 "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/identities/${versionId}/identities/${IdentityId}/accounts'

cURL例 - 問合せパラメータあり

データを制限し、要員IDのみを含めるcURLコマンド。

curl -i -X GET \
   -H "Authorization:Bearer <your access token>" \
 '${service-instance-url}/access-governance/identities/${versionId}/identities/${IdentityId}/accounts?keywordContains=Bill'

レスポンス本文の例

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

{
  "items": [
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.55045.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "passwordChangeStatus": "Never Attempted",
      "isPmProvisioned": true,
      "timeUpdated": null,
      "resourceName": "Database Access Management",
      "orchestratedSystemIdentityId": "targetId.account.ICF.da7efca4-xxxx-4d4f-8ad3-c55ac9362de6.a285ce40190faf23401a9e2c3f35682c",
      "grantType": "DIRECT",
      "orchestratedSystemType": "ICF",
      "risk": "1",
      "isPolicyGrant": false,
      "accountStatus": "ENABLED",
      "canDisable": true,
      "canDelete": true,
      "state": null,
      "orchestratedSystem": {
        "id": "da7efca4-xxxx-4d4f-8ad3-c55ac9362de6",
        "name": "Database Access Management",
        "displayName": null
      }
    },
    {
      "id": "globalId.125123c3-xxxx-4d6a-b6d4-6c0f6537bad2.55045.02e36bbb4b201421b44aa046b3ceb16a",
      "name": "Bill Clark",
      "passwordChangeStatus": "Not Applicable",
      "isPmProvisioned": false,
      "timeUpdated": null,
      "resourceName": "database-tenancy",
      "orchestratedSystemIdentityId": "targetId.account.OCI.bd49ff2a-xxxx-4242-8975-9ba235fbb0ec.fa8db78c5e0b4395354ca399728604fa",
      "grantType": "DIRECT",
      "orchestratedSystemType": "OCI",
      "risk": "1",
      "isPolicyGrant": false,
      "accountStatus": "ENABLED",
      "canDisable": true,
      "canDelete": false,
      "state": null,
      "orchestratedSystem": {
        "id": "bd49ff2a-xxxx-4242-8975-9ba235fbb0ec",
        "name": "Database Performance Optimization OCI",
        "displayName": null
      }
    }
  ]
}

先頭に戻る