SSO User 목록 삭제

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

1개 이상의 SSO User를 삭제합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
POST /api/v1/users/delete

요청 헤더

Ncloud Single Sign-On API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Single Sign-On 요청 헤더를 참조해 주십시오.

요청 바디

요청 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
userIds Array Required SSO User 아이디 목록

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request POST 'https://sso.apigw.gov-ntruss.com/api/v1/users/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 '{
    "userIds": [
        "6b0d0df7-****-****-****-1a11f29b5c34",
        "80d9ba0d-****-****-****-76afe6ea5b33"
    ]
}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String - SSO User 아이디
nrn String - SSO User에 대한 네이버 클라우드 플랫폼 리소스 식별 값
success Boolean - API 처리 결과
  • true | false
    • true: 성공
    • false: 실패
message String - 결과 메시지
  • successfalse인 경우, 표시

응답 상태 코드

Ncloud Single Sign-On API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Single Sign-On 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

[
    {
        "id" : "6b0d0df7-****-****-****-1a11f29b5c34",
        "nrn" : "nrn:PUB:SSO::*******:User/6b0d0df7-****-****-****-1a11f29b5c34",
        "success" : true
    },
    {
        "id" : "80d9ba0d-****-****-****-76afe6ea5b33",
        "nrn" : "nrn:PUB:SSO::*******:User/80d9ba0d-****-****-****-76afe6ea5b33",
        "success" : true
    }
]