Edit SSO user access rule
    • PDF

    Edit SSO user access rule

    • PDF

    Article summary

    Available in Classic and VPC

    Edit an SSO user access rule.

    Request

    This section describes the request format. The method and URI are as follows:

    MethodURI
    PUT/api/v1/users/{userId}/access-rules

    Request headers

    For information about the headers common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On request headers.

    Request path parameters

    You can use the following path parameters with your request:

    FieldTypeRequiredDescription
    userIdStringRequiredSSO user ID list

    Request body

    You can include the following data in the body of your request:

    FieldTypeRequiredDescription
    consoleAccessAllowedBooleanRequiredWhether to allow console access
    • true | false
      • true: allow
      • false: not allow
    apiAccessAllowedBooleanRequiredWhether to allow API Gateway access
    • true | false
      • true: allow
      • false: not allow

    Request example

    The request example is as follows:

    curl --location --request PUT 'https://sso.apigw.ntruss.com/api/v1/users/ba0def04-****-****-****-ff0b962016f7/access-rules' \
    --header 'x-ncp-apigw-timestamp: {Timestamp}' \
    --header 'x-ncp-iam-access-key: {Access Key}' \
    --header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
    --data '{
        "consoleAccessAllowed": false,
        "apiAccessAllowed": false
    }'
    

    Response

    This section describes the response format.

    Response body

    The response body includes the following data:

    FieldTypeRequiredDescription
    idString-SSO user ID
    nrnString-NAVER Cloud Platform resource identification value for SSO user
    successBoolean-API processing result
    • true | false
      • true: succeeded
      • false: failed
    messageString-Result message
    • Displayed if success is false

    Response status codes

    For information about the response status codes common to all Ncloud Single Sign-On APIs, see Ncloud Single Sign-On response status codes.

    Response example

    The response example is as follows:

    {
        "id": "ba0def04-****-****-****-ff0b962016f7",
        "nrn": "nrn:PUB:SSO::*******:User/ba0def04-****-****-****-ff0b962016f7",
        "success": true
    }
    

    Was this article helpful?

    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.