Oracle Cloud Infrastructureドキュメント

セルフサービス・ユーザーAPI仕様

セルフサービス・ユーザーAPIを使用して、プロファイル情報、顧客詳細、顧客に関連付けられたCSI、顧客の構成情報、顧客が利用できるセルフサービス機能を取得します。また、ユーザーがタイムゾーン・プリファレンスを設定することもできます。

次のリソースがサポートされています:

ユーザーの取得

このAPIを使用して、ユーザーの詳細を取得します。

API

/selfservice/v1/users/{userEmail}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 自分の詳細にのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

このAPIは、名、姓、ユーザー電子メール、従業員、ユーザー・タイムゾーン・プリファレンスなどのユーザー詳細を返します。

動詞

GET

サンプル・レスポンス

{
  "firstName": "<first name>",
  "lastName": "<last name>",
  "userEmail": "<email ID>",
   "userPreferences": {
    "timezone": "US/Eastern"
  }
}

ユーザーの顧客の取得

このAPIを使用して、顧客の詳細を取得します。

API

/selfservice/v1/users/{userEmail}/customers/

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客詳細にのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、顧客ID、顧客名、顧客コードなどのユーザー顧客詳細を返します。
  • 他のAPIでこの値が必要なため、このAPIは顧客IDを取得します。

動詞

GET

サンプル・レスポンス 

{
  "customers": [
    {
      "customerId": 1417,
      "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
      "customerCode": "OGHS"
    }
  ]
}

ユーザー・プリファレンスの設定

このAPIを使用して、ユーザー・プリファレンスを設定します。

API

/selfservice/v1/users/{userEmail}/preferences/

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 自分のプリファレンスのみ設定できます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

依存関係

機能

  • このAPIは、ユーザーのタイムゾーン・プリファレンスを設定します。
  • 任意の標準タイムゾーンID値を設定できます。

動詞

PUT

サンプル・リクエスト 

{
  "timezone": "US/Eastern"
}

サンプル・レスポンス

HTTP response code : 200

ユーザーのすべてのCSIの取得

このAPIを使用して、ユーザーのすべてのカスタマ・サポートID (CSI)を取得します。

API

/selfservice/v1/users/{userEmail}/customers/supportidentifiers/

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客CSIにのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

このAPIは、ユーザーに関連付けられている顧客のすべてのCSIを返します。

動詞

GET

サンプル・レスポンス

[
  15427061
]

CSIの構成の取得

このAPIを使用して、カスタマ・サポートID (CSI)ですべての構成を取得します。

API

/selfservice/v1/users/{userEmail}/customers/configuration/{supportIdentifier}

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客CSI構成にのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、CSIのサービスやインスタンスなど、すべての構成を一覧表示します。
  • {supportIdentifier} (CSI)は、ユーザーのすべてのCSIの取得APIを使用してフェッチできます。

依存関係

ユーザーのすべてのCSIの取得。

動詞

GET

サンプル・レスポンス

[
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 1689,
        "label": "DOGHSI",
        "name": "DEV",
        "prioritization": "Production Services",
      }
    ],
    "phase": "Implementation",
    "serviceId": 1305,
    "serviceName": "Global Aux SR Process",
    "typeCode": "EBSO"
  }
]

顧客の構成の取得

このAPIを使用して、顧客IDで構成を取得します。

API

/selfservice/v1/users/{userEmail}/customers/{customerId}/configuration

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客構成にのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、顧客IDで識別される顧客のサービスやインスタンスなど、すべての構成をリストします。
  • {customerId}は、ユーザーの顧客の取得APIを使用してフェッチできます。

依存関係

ユーザーの顧客の取得。

動詞

GET

サンプル・レスポンス

[
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 1689,
        "label": "DOGHSI",
        "name": "DEV",
        "prioritization": "Production Services",
      }
    ],
    "phase": "Implementation",
    "serviceId": 1305,
    "serviceName": "Global Aux SR Process",
    "typeCode": "EBSO"
  },
  {
    "customerCode": "OGHS",
    "customerId": 1417,
    "customerName": "ORACLE GLOBAL HOSTED SUPPORT (Internal)",
    "instances": [
      {
        "id": 349004464,
        "label": "TANPCO",
        "name": "TANPCO",
        "prioritization": "Implementation Services",
      }
    ],
    "phase": "Production",
    "serviceId": 315694690,
    "serviceName": "Internal R12  eBiz Instance for R12.2 Patch Testing",
    "typeCode": "OTOI"
  }
]

顧客権限を取得します

このAPIを使用して、すべての顧客権限を取得します。

API

/selfservice/v1/customers/{customerId}/privileges

スコープおよび認可

  • このAPIにアクセスするには、mcs:oci:api:Userスコープが必要です。
  • 顧客権限データにのみアクセスできます。

ヘッダー

  • Authorization: Bearer <Token>

    <Token>は、認可サーバーによって返されるOAUTHトークン(JWTトークン)です。

  • Identifier: <JWKS Identifier>

    <JWKS Identifier>は、セルフサービス・プラットフォームでJWKS URIが顧客管理者によって設定されたときに生成されるGUIDです。

ベース・パス

/selfservice/v1/

機能

  • このAPIは、すべての顧客権限を返します。
  • 顧客権限はサービス・カタログ・レベルです。たとえば、顧客がCEMLIモジュールまたはバウンス・モジュールにアクセスできる場合です。
  • {customerId}は、ユーザーの顧客の取得APIを使用してフェッチできます。

依存関係

ユーザーの顧客の取得。

動詞

GET

サンプル・レスポンス

{
  "bounce": true,
  "cemli": true,
  "config": true
}