Edit SSO user access rule
- Print
- PDF
Edit SSO user access rule
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
Method | URI |
---|---|
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:
Field | Type | Required | Description |
---|---|---|---|
userId | String | Required | SSO user ID list |
Request body
You can include the following data in the body of your request:
Field | Type | Required | Description |
---|---|---|---|
consoleAccessAllowed | Boolean | Required | Whether to allow console access
|
apiAccessAllowed | Boolean | Required | Whether to allow API Gateway access
|
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:
Field | Type | Required | Description |
---|---|---|---|
id | String | - | SSO user ID |
nrn | String | - | NAVER Cloud Platform resource identification value for SSO user |
success | Boolean | - | API processing result
|
message | String | - | Result message
|
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?