公開
マニュアル一覧へ

ご契約者向け
マニュアル一覧へ

IIJ IDサービス APIリファレンス

ユーザAPI

ユーザの取得

特定のユーザを取得します。

項目値
HTTPメソッドGET
URLhttps://scim.auth.iij.jp/scim/v2/Users/{ユーザの`id`}
スコープ

アクセストークン発行時に以下のスコープが必要です。

  • escim_read_users
リクエスト例
リクエストボディ
なし
レスポンス例
ステータスコード
 200
レスポンスボディ
 {
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
    "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
  ],
  "id": "abc01234-12ab-12ab-0123-456abc",
  "externalId": "",
  "meta": {
    "resourceType": "User",
    "created": "2018-07-31T17:50:07+09:00",
    "lastModified": "2019-08-21T15:39:39+09:00",
    "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abc"
  },
  "userName": "iij-taro@example.com",
  "name": {
    "familyName": "iij",
    "givenName": "taro"
  },
  "displayName": "iij taro",
  "title": "部長",
  "userType": "",
  "preferredLanguage": "ja-JP",
  "timezone": "Asia/Tokyo",
  "active": true,
  "emails": [
    {
      "value": "iij-taro@example.com",
      "primary": true
    }
  ],
  "phoneNumbers": [],
  "ims": [
    {
      "value": "iij-taro@example.com",
      "display": "メッセンジャーA",
      "type": "XMPP",
      "primary": false
    }
  ],
  "entitlements": [],
  "x509Certificates": [],
  "groups": [
    {
      "display": "A-group",
      "value": "abc01234-12ab-12ab-0123-456abd",
      "$ref": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abd"
    },
    {
      "display": "B-group",
      "value": "abc01234-12ab-12ab-0123-456abe",
      "$ref": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abe"
    }
  ],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "example.com",
    "department": "営業課"
  },
  "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User": {
    "localNames": [
      {
        "locale": "ja-JP",
        "familyName": "iij",
        "givenName": "taro",
        "display": "iij taro",
        "primary": true,
        "type": "ja-JP"
      },
      {
        "locale": "ja-Hira-JP",
        "familyName": "あいあいじぇい",
        "givenName": "たろう",
        "display": "あいあいじぇい たろう",
        "primary": false,
        "type": "ja-Hira-JP"
      }
    ]
  },
  "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User": {
    "externalUserName": "iij-taro@example.jp",
    "idTokenClaims": {
      "issuer": "https://idp.example.jp/op",
      "subject": "ab9xcmf3bbD90bds"
    }
  }
}
ユーザの検索

ユーザを検索します。

項目値
HTTPメソッドPOST
URLhttps://scim.auth.iij.jp/scim/v2/Users/.search
スコープ

アクセストークン発行時に以下のスコープが必要です。

  • escim_read_users
リクエスト例
リクエストボディ
 {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:SearchRequest"
  ],
  "filter": "meta.lastModified gt \"2019-08-21T00:00:00Z\""
}
レスポンス例
ステータスコード
200
レスポンスボディ
 {
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 2,
  "startIndex": 1,
  "itemsPerPage": 2,
  "Resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
        "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
      ],
      "id": "abc01234-12ab-12ab-0123-456abc",
      "externalId": "",
      "meta": {
        "resourceType": "User",
        "created": "2018-07-31T17:50:07+09:00",
        "lastModified": "2019-08-21T15:39:39+09:00",
        "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abc"
      },
      "userName": "iij-taro@example.com",
      "name": {
        "familyName": "iij",
        "givenName": "taro"
      },
      "displayName": "iij taro",
      "title": "部長",
      "userType": "",
      "preferredLanguage": "ja-JP",
      "timezone": "Asia/Tokyo",
      "active": true,
      "emails": [
        {
          "value": "iij-taro@example.com",
          "primary": true
        }
      ],
      "phoneNumbers": [],
      "ims": [
        {
          "value": "iij-taro@example.com",
          "display": "メッセンジャーA",
          "type": "XMPP",
          "primary": false
        }
      ],
      "entitlements": [],
      "x509Certificates": [],
      "groups": [
        {
          "display": "A-group",
          "value": "abc01234-12ab-12ab-0123-456abd",
          "$ref": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abd"
        },
        {
          "display": "B-group",
          "value": "abc01234-12ab-12ab-0123-456abe",
          "$ref": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abe"
        }
      ],
      "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
        "organization": "example.com",
        "department": "営業課"
      },
      "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User": {
        "localNames": [
          {
            "locale": "ja-JP",
            "familyName": "iij",
            "givenName": "taro",
            "display": "iij taro",
            "primary": true,
            "type": "ja-JP"
          },
          {
            "locale": "ja-Hira-JP",
            "familyName": "あいあいじぇい",
            "givenName": "たろう",
            "display": "あいあいじぇい たろう",
            "primary": false,
            "type": "ja-Hira-JP"
          }
        ]
      },
      "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User": {
        "externalUserName": "iij-taro@example.jp",
        "idTokenClaims": {
          "issuer": "https://idp.example.jp/op",
          "subject": "ab9xcmf3bbD90bds"
        }
      }
    },
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User",
        "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
        "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
        "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
      ],
      "id": "abc01234-12ab-12ab-0123-456abd",
      "externalId": "",
      "meta": {
        "resourceType": "User",
        "created": "2017-01-24T14:18:47+09:00",
        "lastModified": "2019-08-21T13:00:26+09:00",
        "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abd"
      },
      "userName": "iij-jiro@example.com",
      "name": {
        "familyName": "iij",
        "givenName": "jiro"
      },
      "displayName": "iij jiro",
      (省略)
    }
  ]
}
ユーザの作成

ユーザを作成します。

項目値
HTTPメソッドPOST
URLhttps://scim.auth.iij.jp/scim/v2/Users
スコープ

アクセストークン発行時に以下のスコープが必要です。

  • escim_write_users
リクエスト例
リクエストボディ
 {
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "userName": "iij-saburo@example.com",
  "name": {
    "familyName": "iij",
    "givenName": "saburo"
  },
  "active": true,
  "emails": [
    {
      "value": "iij-saburo@example.com",
      "primary": true
    }
  ]
}
レスポンス例
ステータスコード
201
レスポンスボディ
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
    "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
  ],
  "id": "abc01234-12ab-12ab-0123-456abc",
  "externalId": "",
  "meta": {
    "resourceType": "User",
    "created": "2019-08-21T21:20:47+09:00",
    "lastModified": "2019-08-21T21:20:47+09:00",
    "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abc"
  },
  "userName": "iij-saburo@example.com",
  "name": {
    "familyName": "iij",
    "givenName": "saburo"
  },
  "displayName": "iij saburo",
  "title": "",
  "userType": "",
  "preferredLanguage": "ja-JP",
  "timezone": "Asia/Tokyo",
  "active": true,
  "emails": [
    {
      "value": "iij-saburo@example.com",
      "primary": true
    }
  ],
  "phoneNumbers": [],
  "ims": [],
  "entitlements": [],
  "x509Certificates": [],
  "groups": [],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "example.com",
    "department": ""
  },
  "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User": {
    "localNames": [
      {
        "locale": "ja-JP",
        "familyName": "iij",
        "givenName": "saburo",
        "display": "iij saburo",
        "primary": true,
        "type": "ja-JP"
      },
      {
        "locale": "ja-Hira-JP",
        "familyName": "",
        "givenName": "",
        "display": " ",
        "primary": false,
        "type": "ja-Hira-JP"
      }
    ]
  },
  "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User": {
    "externalUserName": "",
    "idTokenClaims": {
      "issuer": "",
      "subject": ""
    }
  }
}
ユーザの更新

ユーザを更新します。

項目値
HTTPメソッドPUT
URL https://scim.auth.iij.jp/scim/v2/Users/{ユーザの`id`}
スコープ

アクセストークン発行時に以下のスコープが必要です。

  • escim_write_users
リクエスト例
リクエストボディ
{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
    "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
  ],
  "id": "abc01234-12ab-12ab-0123-456abc",
  "externalId": "",
  "meta": {
    "resourceType": "User",
    "created": "2019-08-21T21:20:47+09:00",
    "lastModified": "2019-08-21T21:20:47+09:00",
    "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abc"
  },
  "userName": "iij-saburo@example.com",
  "name": {
    "familyName": "iij",
    "givenName": "saburo"
  },
  "displayName": "iij saburo",
  "title": "課長",
  "userType": "",
  "preferredLanguage": "ja-JP",
  "timezone": "Asia/Tokyo",
  "active": true,
  "emails": [
    {
      "value": "iij-saburo@example.com",
      "primary": true
    }
  ],
  "phoneNumbers": [],
  "ims": [],
  "entitlements": [],
  "x509Certificates": [],
  "groups": [],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "example.com",
    "department": ""
  },
  "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User": {
    "localNames": [
      {
        "locale": "ja-JP",
        "familyName": "iij",
        "givenName": "saburo",
        "display": "iij saburo",
        "primary": true,
        "type": "ja-JP"
      },
      {
        "locale": "ja-Hira-JP",
        "familyName": "",
        "givenName": "",
        "display": " ",
        "primary": false,
        "type": "ja-Hira-JP"
      }
    ]
  },
  "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User": {
    "externalUserName": "",
    "idTokenClaims": {
      "issuer": "",
      "subject": ""
    }
  }
}
レスポンス例
ステータスコード
200
レスポンスボディ
 {
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User",
    "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
    "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User",
    "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User"
  ],
  "id": "abc01234-12ab-12ab-0123-456abc",
  "externalId": "",
  "meta": {
    "resourceType": "User",
    "created": "2019-08-21T21:20:47+09:00",
    "lastModified": "2019-08-21T21:27:00+09:00",
    "location": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abc"
  },
  "userName": "iij-saburo@example.com",
  "name": {
    "familyName": "iij",
    "givenName": "saburo"
  },
  "displayName": "iij saburo",
  "title": "課長",
  "userType": "",
  "preferredLanguage": "ja-JP",
  "timezone": "Asia/Tokyo",
  "active": true,
  "emails": [
    {
      "value": "iij-saburo@example.com",
      "primary": true
    }
  ],
  "phoneNumbers": [],
  "ims": [],
  "entitlements": [],
  "x509Certificates": [],
  "groups": [],
  "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {
    "organization": "example.com",
    "department": ""
  },
  "urn:oidfj:params:scim:schemas:extention:enterprisejp:2.0:User": {
    "localNames": [
      {
        "locale": "ja-JP",
        "familyName": "iij",
        "givenName": "saburo",
        "display": "iij saburo",
        "primary": true,
        "type": "ja-JP"
      },
      {
        "locale": "ja-Hira-JP",
        "familyName": "",
        "givenName": "",
        "display": " ",
        "primary": false,
        "type": "ja-Hira-JP"
      }
    ]
  },
  "urn:iij:params:scim:schemas:extension:enterprisejp:2.0:User": {
    "externalUserName": "",
    "idTokenClaims": {
      "issuer": "",
      "subject": ""
    }
  }
}
ユーザの削除

ユーザを削除します。

項目値
HTTPメソッド DELETE
URL https://scim.auth.iij.jp/scim/v2/Users/{ユーザの`id`}
スコープ

アクセストークン発行時に以下のスコープが必要です。

  • escim_write_users
リクエスト例
リクエストボディ
なし
レスポンス例
ステータスコード
 204
レスポンスボディ
なし