グループの取得
特定のグループを取得します。
| 項目 |
値 |
| HTTPメソッド |
GET |
| URL |
https://scim.auth.iij.jp/scim/v2/Groups/{グループの`id`} |
スコープ
アクセストークン発行時に以下のスコープが必要です。
リクエスト例
レスポンス例
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember" |
], |
"id": "abc01234-12ab-12ab-0123-456abc", |
"externalId": "", |
"displayName": "GroupA", |
"meta": { |
"resourceType": "Group", |
"created": "2019-07-17T12:04:19+09:00", |
"lastModified": "2019-07-17T12:04:19+09:00", |
"location": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abc" |
}, |
"members": [ |
{ |
"display": "iij-taro@example.com", |
"value": "abc01234-12ab-12ab-0123-456abd", |
"$ref": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abd" |
} |
], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "", |
"email": "", |
"groupType": "" |
}, |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember": { |
"emails": [ |
{ |
"value": "iij-taro@example.com", |
"primary": true, |
"$ref": "https://scim.auth.iij.jp/scim/v2/Users/abc01234-12ab-12ab-0123-456abd" |
} |
] |
} |
} |
グループの検索
グループを検索します。
| 項目 |
値 |
| HTTPメソッド |
POST |
| URL |
https://scim.auth.iij.jp/scim/v2/Groups/.search |
スコープ
アクセストークン発行時に以下のスコープが必要です。
リクエスト例
{ |
"schemas": [ |
"urn:ietf:params:scim:api:messages:2.0:SearchRequest" |
], |
"filter": "meta.lastModified gt \"2019-08-18T00:00:00Z\"" |
} |
レスポンス例
{ |
"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:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember" |
], |
"id": "abc01234-12ab-12ab-0123-456abc", |
"externalId": "abc01234-12ab-12ab-0123-456abd", |
"displayName": "GroupA", |
"meta": { |
"resourceType": "Group", |
"created": "2019-08-19T18:02:31+09:00", |
"lastModified": "2019-08-19T18:02:31+09:00", |
"location": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abc" |
}, |
"members": [], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関西支社のグループ", |
"email": "iij-taro@example.com", |
"groupType": "" |
} |
}, |
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember" |
], |
"id": "abc01234-12ab-12ab-0123-456abd", |
"externalId": "abc01234-12ab-12ab-0123-456abe", |
"displayName": "GroupB", |
"meta": { |
"resourceType": "Group", |
"created": "2019-08-19T17:37:50+09:00", |
"lastModified": "2019-08-19T17:37:50+09:00", |
"location": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abd" |
}, |
"members": [], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関東支社のグループ", |
"email": "iij-taro@example.com", |
"groupType": "" |
} |
} |
] |
} |
グループの作成
グループを作成します。
| 項目 |
値 |
| HTTPメソッド |
POST |
| URL |
https://scim.auth.iij.jp/scim/v2/Groups |
スコープ
アクセストークン発行時に以下のスコープが必要です。
リクエスト例
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group" |
], |
"externalId": "abc01234-12ab-12ab-0123-456abd", |
"displayName": "GroupA", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関西支社のグループ", |
"email": "iij-taro@example.com" |
} |
} |
レスポンス例
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember" |
], |
"id": "abc01234-12ab-12ab-0123-456abc", |
"externalId": "abc01234-12ab-12ab-0123-456abd", |
"displayName": "GroupA", |
"meta": { |
"resourceType": "Group", |
"created": "2019-08-19T18:02:31+09:00", |
"lastModified": "2019-08-19T18:02:31+09:00", |
"location": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abc" |
}, |
"members": [], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関西支社のグループ", |
"email": "iij-taro@example.com", |
"groupType": "" |
} |
} |
グループの更新
グループを更新します。
| 項目 |
値 |
| HTTPメソッド |
PUT |
| URL |
https://scim.auth.iij.jp/scim/v2/Groups/{グループの`id`} |
スコープ
アクセストークン発行時に以下のスコープが必要です。
リクエスト例
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group" |
], |
"externalId": "abc01234-12ab-12ab-0123-456abd", |
"displayName": "GroupA", |
"members": [ |
], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関西支社のグループ", |
"email": "iij-taro@example.com", |
"groupType": "security" |
} |
} |
レスポンス例
{ |
"schemas": [ |
"urn:ietf:params:scim:schemas:core:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group", |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:GroupMember" |
], |
"id": "abc01234-12ab-12ab-0123-456abc", |
"externalId": "abc01234-12ab-12ab-0123-456abd", |
"displayName": "GroupA", |
"meta": { |
"resourceType": "Group", |
"created": "2019-08-19T18:02:31+09:00", |
"lastModified": "2019-08-21T21:36:15+09:00", |
"location": "https://scim.auth.iij.jp/scim/v2/Groups/abc01234-12ab-12ab-0123-456abc" |
}, |
"members": [], |
"urn:iij:params:scim:schemas:extension:enterprise:2.0:Group": { |
"description": "関西支社のグループ", |
"email": "iij-taro@example.com", |
"groupType": "security" |
} |
} |
グループの削除
グループを削除します。
| 項目 |
値 |
| HTTPメソッド |
DELETE |
| URL |
https://scim.auth.iij.jp/scim/v2/Groups/{グループの`id`} |
スコープ
アクセストークン発行時に以下のスコープが必要です。
リクエスト例
レスポンス例