SCIM 2.0 for CORE API (1.0.0)

Download OpenAPI specification:Download

Rate Limit

当ドキュメントにおけるRate Limitは、ご利用中のすべてのお客様に対して 2025/4/1 より適用されます

Rate Limitの単位

HRMOS SCIM 2.0 API では、以下の単位でRate Limitを設けています。

単位	Limit
APIトークンあたり	`600 request/minute`
API全体	`6000 request/minute`

API全体部分は、HRMOS SCIM 2.0 API全体へのアクセスで計算されます。

Rate Limitの計算

Rate Limitは、 直近60秒間のrequest数の積算 から計算されます。これにはerrorとなったリクエストも含まれます。（Rate Limitにヒットした後のリクエストも積算対象です）

例： SCIMを 15 request/secondで60秒実行した場合
15 * 60 = 900 = 最後の300前後はRate Limit。 積算が600を下回るのは 300 / 15 = 20秒以上経過後 となる

Rate Limitのエラー

リクエストが定められたRate Limitに抵触した場合、 429 のステータスコードでエラーレスポンスが返却されます。bodyはありません。

scim/users

従業員一覧の取得

現在登録されている従業員情報の一覧を取得します

Authorizations:

Bearer

Responses

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": "string",
"Resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}
]
}

従業員の登録

従業員を新たに登録します

Authorizations:

Bearer

Request Body schema: application/scim+json

schemas	Array of strings SCIM2.0におけるschemaの一覧固定で以下の値が含まれます。 "urn:ietf:params:scim:schemas:core:2.0:User" "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" "urn:jp.co.bizreach.extensions:core:1.0:User" "urn:jp.co.bizreach.extensions:core:1.0:Resign" "urn:jp.co.bizreach.extensions:core:1.0:Name" "urn:jp.co.bizreach.extensions:core:1.0:Address" "urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
	object (Metadata) SCIM2.0におけるメタデータ
id	string <int64> ユーザーのID
externalId	string ユーザーの外部ID COREにおける実装上は、ユーザーの社員コードが利用されます。
userName	string ユーザー名アカウントメールアドレスとなります。
	object ユーザーの氏名
displayName	string 表示名 "<氏> <名>" となります。
userType	string ユーザーのステータス COREのSCIMにおいては、雇用条件 > 雇用形態のAPI参照コードが表示されます
	Array of objects (Email)
	Array of objects (PhoneNumber)
	Array of objects (Photo)
	Array of objects (Address) ユーザーの住所
	object SCIM 2.0における、企業用の拡張ユーザー情報 https://tools.ietf.org/html/rfc7643#section-4.3
	object (Resign) COREのSCIM拡張退職情報が設定されます。
	object (Name) COREによるSCIM拡張表示名以外の情報を拡張します。
	Array of objects (AddressExtension) SCIM2.0におけるCOREのユーザー情報拡張住所に関する情報を設定します。
	object (UserDepartment) SCIM2.0におけるCOREのユーザー情報拡張従業員の所属部署に関する情報が設定されます。

Responses

Request samples

Payload

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}

従業員情報の取得

現在登録されている従業員の情報を取得します

Authorizations:

Bearer

path Parameters

peopleId

required

string <int64>

社員ID

Responses

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}

従業員の削除

指定された従業員を削除します

Authorizations:

Bearer

path Parameters

peopleId

required

string <int64>

社員ID

Responses

従業員の更新

指定された従業員を更新します

Authorizations:

Bearer

path Parameters

peopleId

required

string <int64>

社員ID

Request Body schema: application/scim+json

schemas	Array of strings SCIM2.0におけるschemaの一覧固定で以下の値が含まれます。 "urn:ietf:params:scim:schemas:core:2.0:User" "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" "urn:jp.co.bizreach.extensions:core:1.0:User" "urn:jp.co.bizreach.extensions:core:1.0:Resign" "urn:jp.co.bizreach.extensions:core:1.0:Name" "urn:jp.co.bizreach.extensions:core:1.0:Address" "urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
	object (Metadata) SCIM2.0におけるメタデータ
id	string <int64> ユーザーのID
externalId	string ユーザーの外部ID COREにおける実装上は、ユーザーの社員コードが利用されます。
userName	string ユーザー名アカウントメールアドレスとなります。
	object ユーザーの氏名
displayName	string 表示名 "<氏> <名>" となります。
userType	string ユーザーのステータス COREのSCIMにおいては、雇用条件 > 雇用形態のAPI参照コードが表示されます
	Array of objects (Email)
	Array of objects (PhoneNumber)
	Array of objects (Photo)
	Array of objects (Address) ユーザーの住所
	object SCIM 2.0における、企業用の拡張ユーザー情報 https://tools.ietf.org/html/rfc7643#section-4.3
	object (Resign) COREのSCIM拡張退職情報が設定されます。
	object (Name) COREによるSCIM拡張表示名以外の情報を拡張します。
	Array of objects (AddressExtension) SCIM2.0におけるCOREのユーザー情報拡張住所に関する情報を設定します。
	object (UserDepartment) SCIM2.0におけるCOREのユーザー情報拡張従業員の所属部署に関する情報が設定されます。

Responses

Request samples

Payload

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:User",
"urn:jp.co.bizreach.extensions:core:1.0:Resign",
"urn:jp.co.bizreach.extensions:core:1.0:Name",
"urn:jp.co.bizreach.extensions:core:1.0:Address",
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"userName": "string",
"name": {"familyName": "string",
"givenName": "string",
"middleName": "string"
},
"displayName": "string",
"userType": "string",
"emails": [{"value": "string",
"type": "account",
"primary": true
}
],
"phoneNumbers": [{"type": "work",
"value": "string",
"primary": true
}
],
"photos": [{"value": "string",
"type": "photo"
}
],
"addresses": [{"type": "home",
"postalCode": "string",
"region": "string",
"locality": "string",
"streetAddress": "string",
"additionalAddress": "string"
}
],
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User": {"employeeNumber": "string",
"department": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Resign": {"deactivateDate": "2019-08-24",
"lastWorkingDate": "2019-08-24",
"reason": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Name": {"familyNameKana": "string",
"givenNameKana": "string",
"middleName": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:Address": [{"type": "home",
"regionKana": "string",
"localityKana": "string",
"streetAddressKana": "string",
"additionalAddressKana": "string"
}
],
"urn:jp.co.bizreach.extensions:enterprise:1.0:UserDepartment": {"id": "string",
"internalId": "string",
"code": "string",
"name": "string",
"jobTitleId": "string",
"jobTitleCode": "string",
"jobTitleName": "string"
}
}

scim/groups

部署情報一覧の取得

現在有効な組織改編に登録されている部署情報の一覧を取得します

Authorizations:

Bearer

Responses

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": "string",
"Resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers": {"members": [{"value": "string",
"sortLevel": 0
}
]
}
}
]
}

部署の登録

最新の組織改編に対して部署を登録します

実行時点の日付に対して未来に組織改編が存在する場合は、未来の組織改編に対して部署が登録されます。

Authorizations:

Bearer

Request Body schema: application/scim+json

schemas	Array of strings SCIM2.0におけるschemaの一覧固定で以下の値が含まれます。 "urn:ietf:params:scim:schemas:core:2.0:Group" "urn:jp.co.bizreach.extensions:core:1.0:Team" "urn:jp.co.bizreach.extensions:core:1.0:ParentTeam" "urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
	object (Metadata) SCIM2.0におけるメタデータ
id	string <int64> 部署のID このIDは、組織改編を通じて、同一部署であれば同じIDとなります
externalId	string <int64> 部署の外部向けID COREにおける実装上は、該当部署における部署コードとなります。 nullが指定された場合は、CORE側で自動的に採番されます
	Array of objects (Member) 部署に所属している従業員の一覧
displayName	string 表示名部署名自体となります
	object (Team) 部署に関連する拡張情報
	object (ParentTeam) 親部署に関する拡張情報階層0の部署に関しては内部のフィールドはすべてnullになります

Responses

Request samples

Payload

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
}
}

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers": {"members": [{"value": "string",
"sortLevel": 0
}
]
}
}

部署情報の取得

現時点における指定された部署情報を取得します。

Authorizations:

Bearer

path Parameters

derivedId

required

string <int64>

部署のID

Responses

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers": {"members": [{"value": "string",
"sortLevel": 0
}
]
}
}

部署の編集

指定された部署の情報を編集します。最新の組織改編に適用されます。

Authorizations:

Bearer

path Parameters

derivedId

required

string <int64>

部署のID

Request Body schema: application/scim+json

schemas	Array of strings SCIM2.0におけるschemaの一覧固定で以下の値が含まれます。 "urn:ietf:params:scim:schemas:core:2.0:Group" "urn:jp.co.bizreach.extensions:core:1.0:Team" "urn:jp.co.bizreach.extensions:core:1.0:ParentTeam" "urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
	object (Metadata) SCIM2.0におけるメタデータ
id	string <int64> 部署のID このIDは、組織改編を通じて、同一部署であれば同じIDとなります
externalId	string <int64> 部署の外部向けID COREにおける実装上は、該当部署における部署コードとなります。 nullが指定された場合は、CORE側で自動的に採番されます
	Array of objects (Member) 部署に所属している従業員の一覧
displayName	string 表示名部署名自体となります
	object (Team) 部署に関連する拡張情報
	object (ParentTeam) 親部署に関する拡張情報階層0の部署に関しては内部のフィールドはすべてnullになります

Responses

Request samples

Payload

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
}
}

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers": {"members": [{"value": "string",
"sortLevel": 0
}
]
}
}

部署の削除

指定された部署を廃止します。最新の組織改編に適用されます

Authorizations:

Bearer

path Parameters

derivedId

required

string <int64>

部署のID

Responses

部署情報一覧の取得(日付)

指定された配属日時点における人事異動時点の部署情報の一覧を取得します

Authorizations:

Bearer

path Parameters

assignDate

required

string <date>

配属日

Responses

Response samples

Content type

application/scim+json

{"schemas": ["urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults": "string",
"Resources": [{"schemas": ["urn:ietf:params:scim:schemas:core:2.0:Group",
"urn:jp.co.bizreach.extensions:core:1.0:Team",
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam",
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers"
],
"meta": {"resourceType": "string",
"created": "string",
"lastModified": "string",
"version": "string",
"location": "string"
},
"id": "string",
"externalId": "string",
"members": [{"value": "string",
"$ref": "string",
"title": "string",
"titleEntity": {"id": "string",
"code": "string"
},
"isAdmin": true,
"isMainPosition": true
}
],
"displayName": "string",
"urn:jp.co.bizreach.extensions:core:1.0:Team": {"internalId": "string",
"code": "string",
"nameAlphabet": "string",
"level": 0,
"sortLevel": 0,
"mailingList": "string",
"revisionId": "string",
"revisionName": "string",
"activateAt": "2019-08-24"
},
"urn:jp.co.bizreach.extensions:core:1.0:ParentTeam": {"value": "string",
"$ref": "string",
"name": "string"
},
"urn:jp.co.bizreach.extensions:core:1.0:TeamMembers": {"members": [{"value": "string",
"sortLevel": 0
}
]
}
}
]
}