사용자 정의 정책 존재 여부 확인

Prev Next

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

Permission Set 내 사용자 정의 정책(User Created) 존재 여부를 확인합니다.

요청

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

메서드 URI
GET /api/v1/permission-sets/{permissionSetId}/exists-policy

요청 헤더

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

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
permissionSetId String Required Permission Set 아이디

요청 쿼리 파라미터

요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
policyName String Required 사용자 정의 정책(User Created) 이름

요청 예시

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

curl --location --request GET 'https://sso.apigw.gov-ntruss.com/api/v1/permission-sets/23ab7cb3-****-****-****-0b2222cb93e5/exists-policy?policyName=policy000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
success Boolean - API 처리 결과
  • true | false
    • true: Permission Set이 할당된 계정이 존재하지 않거나 대상 계정에 사용자 정의 정책 존재
    • false: Permission Set이 할당된 계정이 존재하지만 대상 계정에 사용자 정의 정책이 존재하지 않음
message Array - 결과 메시지
  • successfalse인 경우, 표시

message

message에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
accountName String - 계정 사용자 이름
accountMbrNo Number - 계정 회원 번호(MemberNo)

응답 상태 코드

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

응답 예시

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

사용자 정의 정책이 존재하는 경우

사용자 정의 정책이 존재하는 경우의 응답 예시는 다음과 같습니다.

{
    "success": true
}

사용자 정의 정책이 존재하지 않는 경우

사용자 정의 정책이 존재하지 않는 경우의 응답 예시는 다음과 같습니다.

{
    "success": false,
    "message": [
        {
            "accountName": "홍길동",
            "accountMbrNo": *******
        }
    ]
}