Delete SSO user group

Prev Next

Available in Classic and VPC

Delete an SSO user from a group.

Request

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

Method URI
POST /api/v1/users/{userId}/groups/delete

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

Request body

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

Field Type Required Description
groupIds Array Required Group ID list

Request example

The request example is as follows:

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/users/4e6bf5f2-****-****-****-3ffcef11bb7e/groups/delete' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "groupIds": [
        "12cfbd94-****-****-*****-2ff725201395",
        "4674e068-****-****-*****-f669a47cb4ae"
    ]
}'

Response

This section describes the response format.

Response body

The response body includes the following data:

Field Type Required Description
id String - Group ID
success Boolean - API processing result
  • true | false
    • true: succeeded
    • false: failed
message String - 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": "12cfbd94-****-****-*****-2ff725201395",
        "success": true
    },
    {
        "id": "4674e068-****-****-*****-f669a47cb4ae",
        "success": true
    }
]