Login
      Contents x
      Members
        • Print
        • PDF
        Contents

        Members

          • Print
          • PDF
          Article summary

          Description

          Adds, edits and deletes member information of your company in WORKBOX.

          Add

          Adds member information.

          Request URL

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a member

          Request body parameters

          ParameterTypeLengthRequiredDescription
          nameString100YName
          i18nNamesMapNName in multiple languages Map<Locale, String> i18nNames
          deptExternalKeyString36NExternal key for a department
          gradeExternalKeyString100NExternal key for a job grade
          positionExternalKeyString100NExternal key for a job title
          emailAddrString100YBusiness email address (login ID)
          telNoString30NTelephone number
          cphNoString100NMobile phone number
          localeTypeCdStringNLocale information
          tmznTypeCdStringNTimezone information

          Request example

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "positionExternalKey" : "pos001"
}

          Response example

          HTTP/1.1 201 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "emailAddr": "gildong@sample.co.kr",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "localeTypeCd":"ko_KR",
    "tmznTypeCd" : "Asia/Seoul",
    "positionExternalKey" : "pos001"
}

          Edit

          Edits member information.

          You should pass all the information including items you don’t need to edit. (You cannot edit only part of the member information.)

          Request URL

          PUT https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a member

          Request body parameters

          ParameterTypeLengthRequiredDescription
          nameString100YName
          i18nNamesMapNName in multiple languages Map<Locale, String> i18nNames
          deptExternalKeyString36NExternal key for a department
          gradeExternalKeyString100NExternal key for a job grade
          positionExternalKeyString100NExternal key for a job title
          telNoString30NTelephone number
          cphNoString100NMobile phone number
          localeTypeCdStringNLocale information
          tmznTypeCdStringNTimezone information

          Request example

          POST https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001

POST /openapi/v1/organization/company/578c7009-bdad-4493-9835-72302cf988c6/emp/EX00001
HOST: workbox.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-timestamp: 1505290625682
x-ncp-apigw-api-key: DUxjP4HYTP8V7khBkgywdDHQjKuaYWGrppHKpvdv
x-ncp-iam-access-key: D78BB444D6D3C84CA38A
x-ncp-apigw-signature-v1: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=

{
    "deptExternalKey": "00002",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "positionExternalKey" : "pos001"
}

          Response example

          HTTP/1.1 200 OK
Server: nginx
Date: Wed, 12 Sep 2018 10:18:11 GMT
Content-Type: application/json;charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Access-Control-Allow-Origin: *
x-ncp-trace-id: 68d1o68pm4cr63gc3169gm4p34

{
    "deptExternalKey": "00002",
    "name": "홍길동",
    "i18nNames": {
            "ko_KR": "홍길동",
            "en_US": "gildong"
        },
    "gradeExternalKey" : "grade001",
    "telNo" :"0317841111",
    "cphNo" : "01012341234",
    "positionExternalKey" : "pos001"
}

          Delete

          Deletes member information.

          Request URL

          DELETE https://workbox.apigw.ntruss.com/workbox/workbox/openapi/v1/organization/company/{companyId}/user/{externalKey}

          Request header

          HeaderDescription
          x-ncp-apigw-timestampIt is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
          If the time difference with the API Gateway server is more than 5 minutes, the request is considered invalid.
          x-ncp-apigw-timestamp:{Timestamp}
          x-ncp-apigw-api-keyAPI key issued by API Gateway
          x-ncp-apigw-api-key:{API Gateway API Key}
          x-ncp-iam-access-keyAccess Key ID issued from the NAVER CLOUD PLATFORM portal.
          x-ncp-iam-access-key:{Account Access Key}
          x-ncp-apigw-signature-v1Signature encrypted with your Access Key ID and Secret Key.
          x-ncp-apigw-signature-v1:{API Gateway Signature}
          Content-TypeSet the request body content type to application/json.
          Content-Type: application/json

          Request path parameters

          ParameterTypeLengthRequiredDescription
          companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
          externalKeyString36YExternal key for a member

          Response

          It returns an HTTP status code in the response body.

          HTTP status codeResponse messageDescription
          200OKSuccess
          201CreatedResource successfully created.
          400Bad RequestFailure (It is usually used to respond to the request format that the server cannot understand.)
          500Internal Server ErrorGeneral server error. Whereas 4XX error codes represent client-side errors,
          5XX error codes represent server-side errors.

          Available language codes

          Locale codeDescription
          ko_KRKorean
          ja_JPJapanese
          zh_CNSimplified Chinese
          zh_TWTraditional Chinese
          en_USEnglish

          Timezone codes

          timeZone codeDescription
          Pacific/MidwayGMT-11:00(MidwayIsland, Samoa)
          Pacific/HonoluluGMT-10:00(Hawaii)
          Pacific/MarquesasGMT-09:30(Marquesas)
          America/AnchorageGMT-09:00(Alaska)
          America/Los_AngelesGMT-08:00(PacificTime)
          America/DenverGMT-07:00(MountainTime_US/Canada)
          America/ChicagoGMT-06:00(CentralTime_US/Canada)
          America/New_YorkGMT-05:00(EasternTime_US/Canada)
          America/CaracasGMT-04:30(Caracas)
          America/SantiagoGMT-04:00(Santiago)
          America/St_JohnsGMT-03:30(Newfoundland)
          America/Sao_PauloGMT-03:00(SaoPaulo)
          America/NoronhaGMT-02:00(Mid-Atlantic)
          Atlantic/AzoresGMT-01:00(Azores)
          Europe/LondonGMT+00:00(GreenwichMeanTime_London)
          Europe/BerlinGMT+01:00(Amsterdam,Berlin, Vienna)
          Europe/AthensGMT+02:00(Athens, Cairo)
          Asia/BaghdadGMT+03:00(Moscow, Baghdad)
          Asia/TehranGMT+03:30(Tehran)
          Asia/BakuGMT+04:00(Baku, Muscat)
          Asia/KarachiGMT+05:00(Karachi)
          Asia/ColomboGMT+05:30(NewDelhi,Mumbai, Colombo)
          Asia/KatmanduGMT+05:45(Katmandu)
          Asia/DhakaGMT+06:00(Astana, Dhaka)
          Asia/RangoonGMT+06:30(Rangoon)
          Asia/BangkokGMT+07:00(Bangkok, Hanoi,Jakarta)
          Asia/ShanghaiGMT+08:00(Beijing,Dalian, Singapore, Taiwan)
          Asia/SeoulGMT+09:00(Seoul)
          Asia/TokyoGMT+09:00(Tokyo, Fukuoka)
          Australia/DarwinGMT+09:30(Darwin,Adelaide)
          Australia/SydneyGMT+10:00(Guam,Canberra, Sydney)
          Australia/Lord_HoweGMT+10:30(LordHoweIsland)
          Pacific/NoumeaGMT+11:00(NewCaledonia)
          Pacific/NorfolkGMT+11:30(NorfolkIsland)
          Pacific/AucklandGMT+12:00(Auckland,Fiji)
          Was this article helpful?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          First name must have atleast 2 characters. Numbers and special characters are not allowed.
          Last name must have atleast 1 characters. Numbers and special characters are not allowed.
          Enter a valid email
          Enter a valid password
          Your profile has been successfully updated.
          Logout