機械翻訳について

移動先

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

アイデンティティの取得

get

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

指定されたIDを持つアイデンティティ属性など、アイデンティティの詳細を返します。

リクエスト

パス・パラメータ

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

ヘッダー・パラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

指定されたアイデンティティのアイデンティティを取得します。

ヘッダー

• etag: string
  オプティミスティックな同時実行性制御用。 `if-match`を参照してください。
• opc-request-id: string
  リクエストに対するOracleで割り当てられた一意の識別子。 特定のリクエストについてOracleに連絡する必要がある場合は、リクエストIDを指定してください。

本文()

ルート・スキーマ : AccessGovernanceEntity

型: object

Access Governanceエンティティ

ソースを表示

• entityType(required): string
  Access Governanceのエンティティ・タイプ
• id(必須): string
  Access GovernanceエンティティのID
• isRuleBased: boolean
  このアイデンティティはベースですか
• name(required): string
  アクセス・ガバナンス・タイプの名前
• timeCreated(required): string(日時)
  アクセス・ガバナンスによってエンティティが作成された時間
• timeUpdated(required): string(日時)
  エンティティがアクセス・ガバナンスによって最後に変更された時間
• type(必須): string
  許容値: [ "IDENTITY", "IDENTITY_COLLECTION", "ORGANIZATION", "ROLE", "PERMISSION", "ACCESS_BUNDLE", "POLICY", "RESOURCE", "CLOUD_RESOURCE", "ACCOUNT", "OWNERSHIP", "APPROVAL_PROCESS", "TARGET", "ACCESS_GUARDRAIL" ]

  アクセス・ガバナンスのエンティティ・タイプ
• value(required): string
  アクセス・ガバナンス・タイプのjsonスキーマ

{
    "type":"object",
    "required":[
        "entityType",
        "id",
        "name",
        "timeCreated",
        "timeUpdated",
        "type",
        "value"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"The Id for Access Governance Entity"
        },
        "type":{
            "type":"string",
            "description":"The Access Governance Entity Type",
            "enum":[
                "IDENTITY",
                "IDENTITY_COLLECTION",
                "ORGANIZATION",
                "ROLE",
                "PERMISSION",
                "ACCESS_BUNDLE",
                "POLICY",
                "RESOURCE",
                "CLOUD_RESOURCE",
                "ACCOUNT",
                "OWNERSHIP",
                "APPROVAL_PROCESS",
                "TARGET",
                "ACCESS_GUARDRAIL"
            ],
            "x-obmcs-top-level-enum":"#/definitions/EntityType"
        },
        "name":{
            "type":"string",
            "description":"The name for Access Governance Type"
        },
        "timeCreated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was created by Access Governance"
        },
        "timeUpdated":{
            "type":"string",
            "format":"date-time",
            "description":"Time when entity was last modified by Access Governance"
        },
        "isRuleBased":{
            "type":"boolean",
            "description":"Is this identity ruled based"
        },
        "entityType":{
            "type":"string",
            "description":"The Entity type in Access Governance"
        },
        "value":{
            "type":"string",
            "description":"The json schema for Access Governance Type"
        }
    },
    "description":"An Access Governance Entity"
}

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."
}

409レスポンス

競合

ヘッダー

• 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."
}

トップに戻る

例

次の例は、特定のアイデンティティの詳細を取得する方法を示しています。

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

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

レスポンス本文の例

次の例は、アイデンティティの詳細を含む、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "id": "globalId.OCI.xxxxx00000",
  "type": "IDENTITY",
  "name": "[e-mail]",
  "timeCreated": "2025-01-21T01:05:35.558Z",
  "timeUpdated": "2025-01-21T01:05:35.558Z",
  "entityType": "USER",
  "attributes": [
    {
      "name": "agTerminated",
      "value": false
    }
  ],
  "value": "{\"name\":{\"formatted\":\"Clark Bill\",\"familyName\":\"Clark\",\"givenName\":\"Bill\"},\"userName\":\"[e-mail]\",\"displayName\":\"[e-mail]\",\"primaryEmail\":\"[e-mail]\",\"organization\":{\"value\":\"organization.OCI.xxxxx00000\"},\"status\":\"Active\",\"emails\":[{\"primary\":false,\"secondary\":false,\"type\":\"recovery\",\"value\":\"[e-mail]\",\"verified\":false},{\"primary\":true,\"secondary\":false,\"type\":\"work\",\"value\":\"[e-mail]\",\"verified\":false}],\"addresses\":[],\"phoneNumbers\":[],\"agStatus\":\"AG_ACTIVE\",\"agSubType\":\"WORKFORCE\",\"agRisk\":{\"value\":0,\"customAttributes\":{}},\"agDelegation\":{\"hasDelegations\":false,\"customAttributes\":{}},\"agTerminate\":{\"terminated\":false,\"customAttributes\":{}},\"domainOCID\":\"ocid1.domain.oc1.xxxxx00000\",\"userNameDb2\":\"[e-mail]\",\"userNameMysql\":\"BillClarkExampleCom\",\"userNameOracle\":\"[e-mail]\",\"userNameMSSQl\":\"BillClarkExampleCom\",\"agOrganizations\":[],\"targetId\":\"xxxxx00000\",\"identityTargetId\":\"xxxxx00000\",\"compartmentId\":\"xxxxx00000\",\"domainId\":\"xxxxx00000\",\"region\":\"iad:us-ashburn-1\",\"customAttributes\":{\"targetAccounts\":[\"xxxxx00000\"],\"lastModifiedBy\":{\"displayName\":\"AG_Automation_Accessgovtest\",\"ref\":\"${service-instance}/admin/v1/Users/f58b6e9df2ff488bb765cc633f77d42f\",\"resourceType\":\"ACCOUNT\",\"value\":\"xxxxx00000\"},\"createdBy\":{\"displayName\":\"AG_Automation_Accessgovtest\",\"ref\":\"${service-instance}/admin/v1/Users/f58b6e9df2ff488bb765cc633f77d42f\",\"resourceType\":\"ACCOUNT\",\"value\":\"xxxxx00000\"},\"isCorrelated\":true,\"fullDN\":\"[e-mail]_Tags\",\"domainName\":\"Default\",\"ocid\":\"ocid1.user.oc1.xxxxx00000\",\"compartmentOCID\":\"xxxxx00000\",\"compartmentName\":\"accessgovtest\",\"cloudAccountName\":\"accessgovtest\"},\"id\":\"xxxxx00000\",\"externalId\":\"xxxxx00000\",\"schemas\":[],\"meta\":{\"resourceType\":\"USER\",\"created\":1737421535558,\"lastModified\":1737421535558,\"version\":\"1\",\"location\":\"\"}}"
}

先頭に戻る