顧客企業の登録

POST/partners/customers

顧客企業を登録する。

Authorization

oauth2

Authorization Code OAuth Flow

Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
Refresh URL - https://auth.worksmobile.com/oauth2/v2.0/token

Scope

partner

HTTP Request

POSThttps://www.worksapis.com/v1.0/partners/customers

Header Parameters

HeadertypeDescription
Authorizationstring

Bearer {token}


required
Content-Typestring

application/json


required
example : application/json

Request Body

PropertyTypeDescription
domainstring

ドメイン名
文字の英数小文字、ハイフン(-:ただし最初と最後および連続使用を除く)のみ利用可能


required
minLength : 2
maxLength : 22
productIdstring

商品ID

  • FR: Free
  • STD_T: Standard
  • ADV_T: Advanced

required
Allowed values : FR, STD_T, ADV_T
companyNamestring

企業/団体名


required
maxLength : 40
phoneNumberstring

電話番号
数字および P T - * # + ,のみ指定可


required
timeZonestring

タイムゾーンコード


required
localestring

言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_TW, zh_CN
administratorobject (administrator)
partnershipobject (partnership)

administrator

PropertyTypeDescription
lastNamestring


姓、名は合計80字まで指定可能。
使用可能な特殊文字: ! @ & ( ) - _ + [ ] { } , .


required
maxLength : 80
firstNamestring


姓、名は合計80字まで指定可能。
使用可能な特殊文字: ! @ & ( ) - _ + [ ] { } , .

passwordstring

管理者パスワード
「英数字」または「英数字+特殊文字」の混合で指定可。
3字以上連続または反復する文字、数字は利用不可能。
BASE64でエンコードして指定する。


required
minLength : 8
maxLength : 20
idstring

ユーザーID
例) test@example.com ならば'test'のみ指定する。
英数小文字および . - _ のみ使用可


required
minLength : 2
maxLength : 40
privateEmailstring

個人メールアドレス


required
cellphonestring

携帯電話番号
数字および P T - * # + , のみ使用可

countryCodestring

国家コード
cellphone 指定時に必須。

partnership

PropertyTypeDescription
enablePartnerProfileDisplayboolean

パートナープロフィール表示有効フラグ

Request Example

example

1{
2  "domain": "example.com",
3  "productId": "STD_T",
4  "companyName": "ワークスモバイルジャパン株式会社",
5  "phoneNumber": "03-0000-0000",
6  "timeZone": "Asia/Tokyo",
7  "locale": "ja_JP",
8  "administrator": {
9    "lastName": "ワークス",
10    "firstName": "管理者",
11    "id": "admin",
12    "password": "UGFydG5lcjk4IQ==",
13    "privateEmail": "private.works@example.com",
14    "cellphone": "090-0000-0000",
15    "countryCode": "+81"
16  },
17  "partnership": {
18    "enablePartnerProfileDisplay": true
19  }
20}

Response

HTTP 201

OK

PropertyTypeDescription
tenantIdinteger

テナントID


required
readOnly : true
domainIdinteger

ドメインID


required
readOnly : true
domainstring

ドメイン名


required
productIdstring

商品ID

  • FR: Free
  • LT_T: Lite Trial
  • BS_T: Basic Trial
  • PRM_T: Premium Trial
  • STD_T : Standard Trial
  • ADV_T : Advanced Trial
  • LT: Lite
  • BS: Basic
  • PRM: Premium
  • STD: Standard
  • ADV: Advanced

required
Allowed values : FR, LT_T, BS_T, PRM_T, STD_T, ADV_T, LT, BS, PRM, STD, ADV
companyNamestring

顧客企業/団体名


required
phoneNumberstring

電話番号


required
timeZonestring

タイムゾーンコード


required
localestring

言語コード


required
Allowed values : ja_JP, ko_KR, en_US, zh_TW, zh_CN
enableActiveMxrecordboolean

MXレコード設定有効フラグ


required
enableActiveDomainboolean

ドメイン所有権有効フラグ


required
domainTypestring

ドメインタイプ

  • DOMAIN: ドメイン
  • GROUP: グループ

required
Allowed values : DOMAIN, GROUP
administratorobject (administrator)

管理者情報

partnershipobject (partnership)

ドメイン情報

administrator

PropertyTypeDescription
lastNamestring


required
firstNamestring

idstring

ユーザーID


required
privateEmailstring

個人メールアドレス


required
format : email
cellphonestring

携帯電話番号

countryCodestring

国家コード

partnership

PropertyTypeDescription
statusstring

パートナー状態

  • TRANSFER_READY: Online Directからパートナーに転換した後、顧客企業が承認する前の待機状態
  • TERMS_AGREEMENT_READY: 規約に同意する前の状態
  • APPROVED: パートナーシップが締結された状態

Allowed values : TRANSFER_READY, TERMS_AGREEMENT_READY, APPROVED
customerCodestring

管理用識別コード

enablePartnerProfileDisplayboolean

パートナープロフィール表示有効フラグ


required
memostring

メモ


required
enableDeveloperConsoleAccessControlboolean

Developer Consoleのアクセス許可有効フラグ

enableAdminConsoleAccessControlboolean

管理者画面アクセス許可有効フラグ

useOptionPlusboolean

オプションプラス契約済みフラグ

Response Example

example

1{
2  "tenantId": 10000001,
3  "domainId": 10000001,
4  "domain": "example.com",
5  "productId": "STD_T",
6  "companyName": "ワークスモバイルジャパン株式会社",
7  "phoneNumber": "03-0000-0000",
8  "timeZone": "Asia/Tokyo",
9  "locale": "ja_JP",
10  "enableActiveMxrecord": true,
11  "enableActiveDomain": true,
12  "domainType": "DOMAIN",
13  "administrator": {
14    "lastName": "ワークス",
15    "firstName": "管理者",
16    "id": "admin",
17    "privateEmail": "private.works@example.com",
18    "cellphone": "090-0000-0000",
19    "countryCode": "+81"
20  },
21  "partnership": {
22    "status": "TRANSFER_READY",
23    "customerCode": "asd123ada11",
24    "enablePartnerProfileDisplay": true,
25    "memo": "メモ",
26    "enableDeveloperConsoleAccessControl": true,
27    "enableAdminConsoleAccessControl": true,
28    "useOptionPlus": true
29  }
30}