POST/orgunits/external-keys

조직 외부 키 목록을 수정한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

Scope

directory

HTTP Request

POSThttps://www.worksapis.com/v1.0/orgunits/external-keys

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 
Content-Type string 

application/json


required
example : application/json 

Request Body

PropertyTypeDescription
orgUnits array (TenantUniqueExternalKeyRequest) 

외부 키 목록


required
minItems : 1
maxItems : 50 

TenantUniqueExternalKeyRequest

PropertyTypeDescription
id string 

ID

조회 시 리소스에 자동 부여된 ID가 반환된다.
추가/수정/삭제 시에는 아래의 유형을 입력할 수 있다.

  • 메일
  • 리소스 ID
  • 외부 키 "externalKey:{externalKey}" 형태

required 
externalKey string 

고객사에서 관리하는 외부 키.

수정 시 아래와 같이 동작한다.

  • 기존 externalKey값이 없으면 추가된다.
  • 기존 externalKey값이 있으면 변경된다.
  • externalKey값이 빈 값(NULL)이면 삭제된다.
  • 최대 길이는 100글자이며 특수 문자(%, #, /, ?)는 허용하지 않는다.

maxLength : 100 

Request Example

example

1{2  "orgUnits": [3    {4      "id": "orgunitf-f27f-4af8-27e1-03817a911417",5      "externalKey": "ORGUNIT_EXT_01"6    },7    {8      "id": "orgunit7-f511-4757-6040-044af9c9742d",9      "externalKey": "ORGUNIT_EXT_02"10    }11  ]12}

Response

HTTP 204

No Content

HTTP 400

Bad Request

HTTP 404

Not Found

HTTP 409

Conflict