Contents
アカウントの新規作成
組織に新しい管理対象アカウントを作成します。
※認証していないドメインのメールアドレスのアカウントは作成できません。
メソッド
POST
URL
/Users
リクエスト例
リクエストボディ
{
"schemas": [
"urn:ietf:params:scim:schemas:core:2.0:User",
"urn:ietf:params:scim:schemas:extension:enterprise:2.0:User"
],
"userName": "example@nulab.com",
"active": true,
"displayName": "Example Nulab",
"preferredLanguage": "en",
"locale": "en",
"timezone": "Asia/Tokyo",
"roles" : [
{
"value" : "USER",
"primary" : true
}
],
"meta": {
"resourceType": "User"
}
}
リクエスト説明
| 名前 | 型 | 内容 |
|---|---|---|
| schemas（必須） | 文字列 | 固定（リクエスト例の通り） |
| userName（必須） | 文字列 | 認証済みドメインのメールアドレス ※アカウントを一意に識別するもの |
| displayName（必須） | 文字列 | ユーザー名 |
| preferredLanguage | 文字列 | 言語 ※preferredLanguageとlocale両方とも未指定の場合、トークン発行者の言語が管理対象アカウントの言語として登録されます |
| locale | 文字列 | 言語（preferredLanguage が優先される） |
| timezone | 文字列 | タイムゾーン ※未指定の場合、トークン発行者のタイムゾーンが管理対象アカウントのタイムゾーンとして設定されます |
| active | 真偽値 | アカウントのアクティブ/停止中 true: アクティブ false: 停止中 ※新規作成時は true しか指定できません |
| roles.[0].value | 文字列 | ADMIN: 管理者 USER: 一般ユーザー GUEST: ゲスト ※未指定の場合はGUESTになります ※複数指定した場合、primary が true のロールの値が登録されます |
| meta（必須） | ||
| resourceType（必須） | 文字列 | 「User」固定 |
※上記以外の値は登録時に無視されます。
レスポンス例
ステータスライン / レスポンスヘッダ
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
レスポンスボディ
{
"schemas":[
"urn:ietf:params:scim:schemas:core:2.0:User"
],
"id": "6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu",
"meta":{
"resourceType": "User",
"created": "2024-03-22T04:42:01Z",
"lastModified": "2024-03-22T04:42:01Z",
"location": "https://api.apps.nulab.com/spaces/aeDWiLzQw/scim/v2/Users/6BV58gRox664F5QKPC9oUWHB23BtJqWVoSmTCzzjpCiKcoCYu"
},
"userName": "example@nulab.com",
"displayName": "Example Nulab",
"preferredLanguage": "en",
"locale": "en",
"timezone": "Asia/Tokyo",
"active": true,
"roles":[
{
"value": "USER",
"primary": true
}
]
}
レスポンス説明
| 名前 | 型 | 内容 |
|---|---|---|
| id | 文字列 | アカウントのID ※アカウントを一意に識別する文字列 |
| userName | 文字列 | メールアドレス ※アカウントを一意に識別するもの |
| displayName | 文字列 | ユーザー名 |
| preferredLanguage | 文字列 | 言語（locale と同じ値） |
| locale | 文字列 | 言語（preferredLanguage と同じ値） |
| timezone | 文字列 | タイムゾーン |
| active | 真偽値 | アカウントのアクティブ/停止中 true: アクティブ false: 停止中 |
| roles.[0].value | 文字列 | ADMIN: 管理者 USER: 一般ユーザー GUEST: ゲスト |