Get primary admin
    • PDF

    Get primary admin

    • PDF

    Article Summary

    Description

    Gets the primary administrator of your company in WOKPLACE.

    Get primary administrator

    Gets whether an employee is the primary administrator.

    Request URL

    GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/{companyId}/auth/{externalKey}
    

    Request header

    HeaderDescription
    x-ncp-apigw-timestamp* This is the number of milliseconds that have elapsed since January 1, 1970 00:00:00 UTC.
    * If the time difference compared to the API Gateway server is more than 5 minutes, then the request is considered invalid.
    x-ncp-iam-access-key* Access Key ID issued on NAVER Cloud Platform portal or by Sub Account
    x-ncp-apigw-signature-v2* A signature that encrypts the body of the example above with Secret Key mapped to the access key ID
    * HmacSHA256 is used as the HMAC encryption algorithm

    Request path parameters

    ParameterTypeLengthRequiredDescription
    companyIdString36YAPI key (CompanyId). Developers > Basic Settings > API Key
    externalKeyString36YAdditional property’s external key

    Request example

    GET https://workplace.apigw.ntruss.com/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/auth/759d67ab-bdca-406a-9cf0-834e0288bf4f
    

    Response example

    {
        "timestamp": "2019-12-13 16:04:07",
        "status": 200,
        "error": null,
        "message": null,
        "path": "/organization/apigw/v1/company/187d83ad-4038-45b6-8e7c-59eca16fdc46/auth/759d67ab-bdca-406a-9cf0-834e0288bf4f",
        "body": {
            "companyId": "187d83ad-4038-45b6-8e7c-59eca16fdc46",
            "externalKey": "759d67ab-bdca-406a-9cf0-834e0288bf4f",
            "reprYn": "Y"
        }
    }
    

    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.

    Was this article helpful?

    What's Next
    Changing your password will log you out immediately. Use the new password to log back in.
    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.