オンプレミスプロビジョニング用のSCIMメッセージ

Oktaは、利用可能なSCIMメッセージのサブセットを使用して、プロビジョニング命令をSCIMサーバーに送信します。

以下は、Okta SCIMプロビジョニングメッセージです：

実装されているユーザー管理機能を取得する

この命令はアプリインスタンスの構成時に送信され、コネクターが実装したプロビジョニング機能の一覧を返すようにコネクターに要求します。結果に基づいて、適切なプロビジョニング機能がアプリの統合でサポートされます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET /ServiceProviderConfigs

例

GET http://acme.com:8080/ServiceProviderConfigs

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:okta:schemas:scim:providerconfig:1.0"
  ],
  "documentationUrl":"https://support.okta.com/scim-fake-page.html",
  "patch":{
    "supported":false
  },
  "bulk":{
    "supported":false
  },
  "filter":{
    "supported":true,
    "maxResults":100
  },
  "changePassword":{
    "supported":true
  },
  "sort":{
    "supported":false
  },
  "etag":{
    "supported":false
  },
  "authenticationSchemes":[
  ],
  "urn:okta:schemas:scim:providerconfig:1.0":{
    "userManagementCapabilities":[
      "GROUP_PUSH",
      "IMPORT_NEW_USERS",
      "IMPORT_PROFILE_UPDATES",
      "PUSH_NEW_USERS",
      "PUSH_PASSWORD_UPDATES",
      "PUSH_PENDING_USERS",
      "PUSH_PROFILE_UPDATES",
      "PUSH_USER_DEACTIVATION",
      "REACTIVATE_USERS"
    ]
  }
}

ユーザーを作成する

この命令は、新しいユーザーをオンプレミスアプリに割り当てる際に送信されます。

Oktaは2つのメッセージを送信します。最初のメッセージは、オンプレミスアプリにユーザーが存在するかどうかを判断します。オンプレミスアプリにユーザーが存在しない場合、Oktaはもう1つのメッセージを送信してユーザーを作成します。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET /Users?filter=userName%20eq%20%22myemail%40example.com%22&startIndex=1&count=100

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

以下は、ユーザーが存在しない場合に返される内容の例です：

{
  "schemas": [
    "urn:scim:schemas:core:1.0"
  ],
  "totalResults": 0,
  "startIndex": 1,
  "itemsPerPage": 0,
  "Resources": []
}

次の例は、ユーザーが存在する場合に返される内容を示しています。

{
  "totalResults":1,
  "schemas":["urn:scim:schemas:core:1.0"],
  "Resources":[
    {
      "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:scim:schemas:extension:enterprise:1.0",
        "urn:okta:onprem_app:1.0:user:custom"
      ],
      "id": "102",
      "userName": "admin",
      "password": "fakepassword",
      "active": false,
      "name": {
        "formatted": "Barbara Jensen",
        "givenName": "Barbara",
        "familyName": "Jensen"
      },
      "emails": [
        {
          "value": "bjensen@example.com",
          "primary": true,
          "type": "work"
        }
      ],
      "groups": [
        {
          "value": "1002",
          "display": "secondGroup"
        }
      ],
      "urn:okta:onprem_app:1.0:user:custom": {
        "isAdmin": true,
        "isOkta": false,
        "departmentName": "Administration"
      }
    }
  ]
}

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

POST /Users

例：

http://acme.com:8080/Users
"schemas":[
  "urn:scim:schemas:core:1.0",
  "urn:okta:onprem_app:1.0:user:custom"
],
"userName":"myemail@example.com",
"emails":[
  {
    "primary":true,
    "value":"myemail@example.com",
    "type":"primary"
  },
  {
    "primary":false,
    "value":"mypersonalemail@example.com",
    "type":"secondary"
  }
],
"phoneNumbers":[
  {
    "value":"123-444-5555",
    "type":"mobile"
  }
],
"name":{
  "familyName":"LastName",
  "givenName":"FirstName"
},
"active":true,
"password":"verySecure",
"urn:okta:onprem_app:1.0:user:custom":{
  "isAdmin":false,
  "isOkta":false,
  "departmentName":"Testing User"
  }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "d0dd58e43ded4293a61a8760fcba0458",
  "externalId": "00ustvXq1A8UAuobW0f5",
  "meta": {
    "created": "04-17-2020 00:00:00",
    "lastModified": "04-17-2020 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "steph.c@example.com",
  "displayName": " Steph Curry",
  "preferredLanguage": "en",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "password": "VFhsSlpHVnVkR2wwZVVselRYbFFZWE56ZDI5eVpBPT0=",
  "emails": [
    {
      "value": "steph.c@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [],
  "name": {
    "familyName": "Curry",

保留中のユーザーの作成

この命令は、Oktaでまだアクティブ化されていないOktaユーザーがオンプレミスアプリに割り当てられる際に送信されます。

この呼び出しは前の呼び出しに似ており、activeフィールドが追加されています。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

POST /Users
{
  "schemas":[
  "urn:scim:schemas:core:1.0"
],
"userName":"myemail-pending@example.com",
"emails":[
  {
    "primary":true,
    "value":"myemail-pending@example.com",
    "type":"primary"
  },
  {
    "primary":false,
    "value":"mypersonalemail-pending@example.com",
    "type":"secondary"
  }
],
"phoneNumbers":[
  {
    "value":"123-444-5555",
    "type":"mobile"
  }
],
"name":{
    "familyName":"LastName-pending",
    "givenName":"FirstName-pending"
  },
"active":false,
"password":"verySecure",
"groups":[
  {
    "display":"secondGroup",
    "value":"1002"
  }
  ]
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "d0dd58e43ded4293a61a8760fcba0458",
  "externalId": "00ustvXq1A8UAuobW0f5",
  "meta": {
    "created": "04-17-2020 00:00:00",
    "lastModified": "04-17-2020 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "steph.c@example.com",
  "displayName": " Steph Curry",
  "preferredLanguage": "en",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "password": "VFhsSlpHVnVkR2wwZVVselRYbFFZWE56ZDI5eVpBPT0=",
  "emails": [
    {
      "value": "steph.c@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [],
  "name": {
    "familyName": "Curry",
    "givenName": "Steph"
  },
  "urn:scim:schemas:extension:okta:1.0": {
    "employeeNumber": "30",
    "manager": {
      "value": "Steve Kerr"
    }
  }
}

オンプレミスアプリからOktaにユーザーをインポートする

この命令は、管理者がオンプレミスアプリからOktaにユーザーをインポートする際に送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET /Users?startIndex=1&count=100

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "schemas": [
    "urn:scim:schemas:core:1.0"
  ],
  "totalResults": 3,
  "startIndex": 1,
  "itemsPerPage": 3,
  "Resources": [
    {
      "id": "ce454761d63f4ce4904db3d4b9cc4cc4",
      "externalId": "00uinactiveAuobW0f8",
      "meta": {
        "created": "04-09-2020 00:00:00",
        "lastModified": "10-14-2016 00:00:00",
        "version": "v1.0"
      },
      "schemas": [
        "urn:scim:schemas:core:1.0"
      ],
      "userName": "InactiveScim1User1@example.com",
      "displayName": "Inactive Scim1 Test User",
      "preferredLanguage": "en",
      "locale": "en_US",
      "timezone": "America/Los_Angeles",
      "active": false,
      "password": "UVdKalpERXlNelE9",
      "emails": [
        {
          "value": "InactiveScim1User1@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "groups": [],
      "name": {
        "familyName": "User",
        "givenName": "Inactive Scim1 Test"
      }
    },
    {
      "id": "d0dd58e43ded4293a61a8760fcba0458",
      "externalId": "00ustvXq1A8UAuobW0f5",
      "meta": {
        "created": "04-17-2020 00:00:00",
        "lastModified": "04-17-2020 00:00:00",
        "version": "v1.0"
      },
      "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:scim:schemas:extension:okta:1.0"
      ],
      "userName": "steph.c@example.com",
      "displayName": " Steph Curry",
      "preferredLanguage": "en",
      "locale": "en-US",
      "timezone": "America/Los_Angeles",
      "active": true,
      "password": "VFhsSlpHVnVkR2wwZVVselRYbFFZWE56ZDI5eVpBPT0=",
      "emails": [
        {
          "value": "steph.c@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "groups": [],
      "name": {
        "familyName": "Curry",
        "givenName": "Steph"
      },
      "urn:scim:schemas:extension:okta:1.0": {
        "employeeNumber": "30",
        "manager": {
          "value": "Steve Kerr"
        }
      }
    },
    {
      "id": "45c5f5187556447186bd5a710ba439e9",
      "externalId": "00usabcdeAuobW0f8",
      "meta": {
        "created": "04-09-2020 00:00:00",
        "lastModified": "10-14-2016 00:00:00",
        "version": "v1.0"
      },
      "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:scim:schemas:extension:okta:1.0"
      ],
      "userName": "scim1User1@example.com",
      "displayName": "Scim1 Test User",
      "preferredLanguage": "en",
      "locale": "en_US",
      "timezone": "America/Los_Angeles",
      "active": true,
      "password": "UVdKalpERXlNelE9",
      "emails": [
        {
          "value": "scim1User1@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "groups": [
        {
          "value": "8306945c760d4b0e8fae3e806614a19a",
          "display": "ScimOne Group A"
        }
      ],
      "name": {
        "familyName": "User",
        "givenName": "Scim1 Test"
      },
      "urn:scim:schemas:extension:okta:1.0": {
        "employeeNumber": "11253"
      }
    }
  ]
}

最近変更されたユーザーをオンプレミスアプリからOktaにインポートする

この命令は、管理者がオンプレミスアプリからOktaへのユーザーの増分インポートを実行する際に送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET /Users?filter=meta.lastModified gt "2020-04-07T14:19:34Z"&startIndex=1&count=100

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "schemas": [
    "urn:scim:schemas:core:1.0"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 1,
  "Resources": [
    {
      "id": "d0dd58e43ded4293a61a8760fcba0458",
      "externalId": "00ustvXq1A8UAuobW0f5",
      "meta": {
        "created": "04-17-2020 00:00:00",
        "lastModified": "04-17-2020 00:00:00",
        "version": "v1.0"
      },
      "schemas": [
        "urn:scim:schemas:core:1.0"
        "urn:scim:schemas:extension:okta:1.0"
      ],
      "userName": "steph.c@example.com",
      "displayName": " Steph Curry",
      "preferredLanguage": "en",
      "locale": "en_US",
      "timezone": "America/Los_Angeles",
      "active": true,
      "password": "VFhsSlpHVnVkR2wwZVVselRYbFFZWE56ZDI5eVpBPT0=",
      "emails": [
        {
          "value": "steph.c@example.com",
          "type": "work",
          "primary": true
        }
      ],
      "groups": [],
      "name": {
        "familyName": "Curry",
        "givenName": "Steph"
      }
      "urn:scim:schemas:extension:okta:1.0": {
         "employeeNumber": "30",
         "manager": {
           "value": "Steve Kerr"
         }
      }
    },
  ]
}

ユーザープロファイルをインポートする

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET /Users/<Id>

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "d0dd58e43ded4293a61a8760fcba0458",
  "externalId": "00ustvXq1A8UAuobW0f5",
  "meta": {
    "created": "04-17-2020 00:00:00",
    "lastModified": "04-17-2020 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "steph.c@example.com",
  "displayName": " Steph Curry",
  "preferredLanguage": "en",
  "locale": "en-US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "password": "VFhsSlpHVnVkR2wwZVVselRYbFFZWE56ZDI5eVpBPT0=",
  "emails": [
    {
      "value": "steph.c@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [],
  "name": {
    "familyName": "Curry",
    "givenName": "Steph"
  },
  "urn:scim:schemas:extension:okta:1.0": {
    "employeeNumber": "30",
    "manager": {
      "value": "Steve Kerr"
    }
  }
}

オンプレミスアプリにユーザーが存在することがプロビジョニング中に検出されると、Oktaはオンプレミスアプリにユーザープロファイルをプッシュするか、プロファイルをインポートします。Oktaこの対応は、［プロファイルの更新をプッシュ］オプションが有効化されているかどうかによって異なります。このオプションが有効であれば、Oktaはユーザーのプロファイルをオンプレミスアプリにプッシュします。有効でなければ、Oktaはユーザープロファイルをインポートします。

ユーザーをアクティブ化する

この命令は、過去に非アクティブ状態でプロビジョニングされたユーザーがOktaでアクティブ化される際に送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT /Users/<id
{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:enterprise:1.0",
    "urn:okta:onprem_app:1.0:user:custom"
  ],
  "id":"101",
  "userName":"okta",
  "name":{
    "givenName":"John",
    "familyName":"Smith"
  },
  "emails":[
    {
      "value":"jsmith@example.com",
      "primary":true,
      "type":"work"
    }
  ],
  "active":true,
  "password":"inSecure",
  "groups":[
    {
      "value":"1001",
      "display":"firstGroup"
    },
    {
      "value":"1002",
      "display":"secondGroup"
    }
  ],
  "urn:okta:onprem_app:1.0:user:custom":{
    "isAdmin":false,
    "isOkta":true,
    "departmentName":"Cloud Service"
  }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "45c5f5187556447186bd5a710ba439e9",
  "externalId": "00usabcdeAuobW0f8",
  "meta": {
    "created": "10-14-2016 00:00:00",
    "lastModified": "10-14-2016 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "scim1User1@example.com",
  "displayName": "Scim1 Test User",
  "preferredLanguage": "en",
  "locale": "en_US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "password": "VlZaa1MyRnNjRVZTV0d4T1pXeEZPUT09",
  "emails": [
    {
      "value": "scim1User1@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "8306945c760d4b0e8fae3e806614a19a",
      "display": "ScimOne Group A"
    }
  ],
  "name": {
    "familyName": "User",
    "givenName": "Scim1 Test"
  },
  "urn:scim:schemas:extension:okta:1.0": {
    "employeeNumber": "11253"
  }
}

ユーザーを非アクティブ化

この命令は、ユーザーがOktaアプリの統合から割り当て解除されるか、ユーザーがOktaで非アクティブ化されると送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT /Users/<id>
{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:enterprise:1.0",
    "urn:okta:onprem_app:1.0:user:custom"
  ],
  "id":"101",
  "userName":"okta",
  "name":{
    "givenName":"John",
    "familyName":"Smith"
  },
  "emails":[
    {
      "value":"jsmith@example.com",
      "primary":true,
      "type":"work"
    }
  ],
  "active":false,
  "password":"inSecure",
  "groups":[
    {
      "value":"1001",
      "display":"firstGroup"
    },
    {
      "value":"1002",
      "display":"secondGroup"
    }
  ],
  "urn:okta:onprem_app:1.0:user:custom":{
    "isAdmin":false,
    "isOkta":true,
  "departmentName":"Cloud Service"
  }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "45c5f5187556447186bd5a710ba439e9",
  "externalId": "00usabcdeAuobW0f8",
  "meta": {
    "created": "10-14-2016 00:00:00",
    "lastModified": "10-14-2016 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "scim1User1@example.com",
  "displayName": "Scim1 Test User",
  "preferredLanguage": "en",
  "locale": "en_US",
  "timezone": "America/Los_Angeles",
  "active": false,
  "password": "VlZaa1MyRnNjRVZTV0d4T1pXeEZPUT09",
  "emails": [
    {
      "value": "scim1User1@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "8306945c760d4b0e8fae3e806614a19a",
      "display": "ScimOne Group A"
    }
  ],
  "name": {
    "familyName": "User",
    "givenName": "Scim1 Test"
  },
  "urn:scim:schemas:extension:okta:1.0": {
    "employeeNumber": "11253"
  }
}

ユーザーを再アクティブ化する

この命令は、以前に非アクティブ化されたユーザーがOktaでアクティブ化されると送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT /Users/<id>
{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:enterprise:1.0",
    "urn:okta:onprem_app:1.0:user:custom"
  ],
  "id":"101",
  "userName":"okta",
  "name":{
    "givenName":"John",
    "familyName":"Smith"
  },
  "emails":[
    {
      "value":"jsmith@example.com",
      "primary":true,
      "type":"work"
    }
  ],
  "active":true,
  "password":"inSecure",
  "groups":[
    {
      "value":"1001",
      "display":"firstGroup"
    },
    {
      "value":"1002",
      "display":"secondGroup"
    }
  ],
  "urn:okta:onprem_app:1.0:user:custom":{
    "isAdmin":false,
    "isOkta":true,
    "departmentName":"Cloud Service"
  }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "id": "45c5f5187556447186bd5a710ba439e9",
  "externalId": "00usabcdeAuobW0f8",
  "meta": {
    "created": "10-14-2016 00:00:00",
    "lastModified": "10-14-2016 00:00:00",
    "version": "v1.0"
  },
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:okta:1.0"
  ],
  "userName": "scim1User1@example.com",
  "displayName": "Scim1 Test User",
  "preferredLanguage": "en",
  "locale": "en_US",
  "timezone": "America/Los_Angeles",
  "active": true,
  "password": "VlZaa1MyRnNjRVZTV0d4T1pXeEZPUT09",
  "emails": [
    {
      "value": "scim1User1@example.com",
      "type": "work",
      "primary": true
    }
  ],
  "groups": [
    {
      "value": "8306945c760d4b0e8fae3e806614a19a",
      "display": "ScimOne Group A"
    }
  ],
  "name": {
    "familyName": "User",
    "givenName": "Scim1 Test"
  },
  "urn:scim:schemas:extension:okta:1.0": {
    "employeeNumber": "11253"
  }
}

パスワードの更新をプッシュする

これは、ユーザーがOktaでパスワードを変更し、アプリのプロビジョニング（Provisioning）（Sync Password）タブのアプリへ（To App）でパスワードを同期（Sync Password）（Provisioning）が有効化されている場合に送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT /Users/<id>
{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:scim:schemas:extension:enterprise:1.0",
    "urn:okta:onprem_app:1.0:user:custom"
  ],
  "id":"101",
  "userName":"okta",
  "name":{
    "givenName":"John",
    "familyName":"Smith"
  },
  "emails":[
    {
      "value":"jsmith@example.com",
      "primary":true,
      "type":"work"
    }
  ],
  "active":true,
  "password":"this-is-my-new-password",
  "groups":[
    {
      "value":"1001",
      "display":"firstGroup"
    },
    {
      "value":"1002",
      "display":"secondGroup"
    }
  ],
  "urn:okta:onprem_app:1.0:user:custom":{
    "isAdmin":false,
    "isOkta":true,
    "departmentName":"Cloud Service"
  }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

Oktaは、コネクターからのNon-errorレスポンスがpushPasswordUpdateの成功を意味すると仮定しています。

プロファイルの更新のプッシュ

この命令は、Oktaでユーザーのプロファイルが変更され、アプリでユーザー属性を更新（Update User Attributes）が有効化されている場合に送信されます。ユーザー属性を自動的に更新するを参照してください。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT request to /Users/101
 {
   "schemas":[
      "urn:scim:schemas:core:1.0",
      "urn:scim:schemas:extension:enterprise:1.0",
      "urn:okta:onprem_app:1.0:user:custom"
   ],
   "id":"101",
   "userName":"okta",
   "name":{
      "givenName":"John",
      "familyName":"Taylor"
   },
   "emails":[
      {
         "value":"jtaylor@example.com",
         "primary":true,
         "type":"work"
      }
   ],
   "active":true,
   "password":"inSecure",
   "groups":[
      {
         "value":"1001",
         "display":"firstGroup"
      },
      {
         "value":"1002",
         "display":"secondGroup"
      }
   ],
   "urn:okta:onprem_app:1.0:user:custom":{
      "isAdmin":false,
      "isOkta":true,
      "departmentName":"Cloud Service Management"
   }
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

Oktaは、コネクターからのNon-errorレスポンスがpushProfileUpdateの成功を意味すると仮定しています。ユーザーを作成（Create Users）とユーザー属性を更新（Update User Attributes） が有効化され、オンプレミスアプリユーザーの作成時または更新時にこれらのユーザーが更新される場合、コネクターは更新済みのユーザーを送り返します。アプリの統合にプロビジョニングを構成するを参照してください。

グループをダウンロードする

この命令は、管理者がOktaにユーザーをインポートすると送信されます。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

GET request /Groups?startIndex=1&count=100

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "totalResults":2,
  "schemas":[
    "urn:scim:schemas:core:1.0"
  ],
  "Resources":[
    {
      "schemas":[
        "urn:scim:schemas:core:1.0",
        "urn:okta:custom:group:1.0"
      ],
      "displayName":"firstGroup",
      "id":"1001",
      "members":[
        {
          "value":"101",
          "display":"okta"
        }
      ],
      "urn:okta:custom:group:1.0":{
        "description":"This is the first group"
      }
    },
    {
      "schemas":[
        "urn:scim:schemas:core:1.0"
      ],
      "displayName":"secondGroup",
      "id":"1002",
      "members":[
        {
          "value":"101",
          "display":"okta"
        },
        {
          "value":"102",
          "display":"admin"
        }
      ]
    }
  ]
}

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "totalResults": 2,
  "schemas": [
    "urn:scim:schemas:core:1.0"
  ],
  "Resources": [
    {
      "schemas": [
        "urn:scim:schemas:core:1.0",
        "urn:okta:custom:group:1.0"
      ],
      "displayName": "firstGroup",
      "id": "1001",
      "members": [
        {
          "value": "101",
          "display": "okta"
        }
      ],
      "urn:okta:custom:group:1.0": {
        "description": "This is the first group"
      }
    },
    {
      "schemas": [
        "urn:scim:schemas:core:1.0"
      ],
      "displayName": "secondGroup",
      "id": "1002",
      "members": [
        {
          "value": "101",
          "display": "okta"
        },
        {
          "value": "102",
          "display": "admin"
        }
      ]
    }
  ]
}

グループを作成する

この命令は、Oktaのアプリの統合でグループプッシュ（Group Push）機能が有効化されると送信されます。グループプッシュを有効にするを参照してください。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

POST request to http://localhost:8080/Groups

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

{
  "schemas":[
    "urn:scim:schemas:core:1.0",
    "urn:okta:custom:group:1.0"
  ],
  "displayName":"AppGroup-04",
  "id":"AppGroup-02",
  "members":[
    {
      "value":"101",
      "display":"okta"
    },
    {
      "value":"102",
      "display":"admin"
    }
  ],
  "urn:okta:custom:group:1.0":{
    "description":"This is the second group"
  }
}

グループを更新する

この命令は、Oktaのアプリの統合でグループプッシュ（Group Push）が有効化されると送信されます。グループプッシュを有効にするを参照してください。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

PUT request to http://localhost:8080/Groups/1002

SCIMサーバーとして機能するコネクターからの想定されるレスポンス 

{
  "schemas": [
    "urn:scim:schemas:core:1.0",
    "urn:okta:custom:group:1.0"
  ],
  "displayName": "AppGroup-Changed",
  "id": "1002",
  "members": [
    {
      "value": "101",
      "display": "okta admin"
    },
    {
      "value": "102",
      "display": "okta user"
    }
  ],
  "urn:okta:custom:group:1.0": {
    "description": "This is the changed first group"
  }
}

グループを削除する

この命令は、Oktaのアプリの統合でグループプッシュ（Group Push）が有効化されると送信されます。グループプッシュを有効にするを参照してください。

Okta Provisioning Agent HTTPリクエストとJSONメッセージの例

DELETE request to http://localhost:8080/Groups/1003

SCIMサーバーとして機能するコネクターからの想定されるレスポンス

Oktaは、コネクターからのNon-errorレスポンスは、deleteGroupが成功し、ID 1003のグループが削除されたことを意味すると仮定します。

関連項目

オンプレミスプロビジョニングのSCIMコネクターを作成する

オンプレミスプロビジョニングのSCIMコネクターをテストする