GET/Groups

グループリストを取得する。
外部グループは取得できない。

HTTP Request

GEThttps://www.worksapis.com/scim/v2/Groups

Query Parameters

ParameterTypeDescription
startIndex integer 

Offset


default : 1
minimum : 1 
count integer 

取得数


default : 100
minimum : 0
maximum : 100 
filter string 

フィルター
displayName に対する eq 比較のみ可能
+ は %2B にエンコードする


example : displayName eq "group name" 
excludedAttributes string 

レスポンスから除外する属性


Allowed values : members 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}
長期トークンを参照してください。


required 

Response

HTTP 200

PropertyTypeDescription
schemas array (string) 

Schema URL

 
totalResults integer 

総件数

 
startIndex integer 

Offset

 
itemsPerPage integer 

ページあたりの件数

 
resources array (ScimGroupResponse) 

グループ情報

 

ScimGroupResponse

PropertyTypeDescription
schemas array (string) 

Schema URL

 
id string 

グループ ID

 
externalId string 

SCIM クライアントで管理する ID

 
displayName string 

グループ名

 
members array (ScimGroupMember) 

グループのメンバーリスト

 
meta object (meta) 
 

ScimGroupMember

PropertyTypeDescription
value string 

グループメンバー ID (ユーザー ID または グループ ID)


required 
type string 

グループメンバータイプ


Allowed values : USER, GROUP
readOnly : true 
display string 

グループメンバー名 (ユーザー名 または グループ名)


readOnly : true 
$ref string 

参照 URL
グループメンバーの詳細情報の参照 URL


readOnly : true 

meta

PropertyTypeDescription
resourceType string 

リソースタイプ


Allowed values : USER, GROUP 
created string 

作成日時

 
lastModified string 

最終更新日時

 
location string 

リソース URI

 

HTTP 400

Bad Request