checkPermissionSetPolicyExists

이 가이드는 API 명세를 기반으로 AI가 자동 생성했습니다.

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

Ncloud 표준 표현을 적용한 API입니다.

Permission Set에 Assignment 된 각 계정의 IAM 에 입력한 이름의 사용자 정의 정책이 존재하는지 확인합니다. 정책 이름 자체를 검증하지 않으며, 정책이 없는 계정이 있으면 success: false 와 해당 계정 목록을, Assignment 된 계정이 없으면 확인 대상이 없어 success: true를 응답합니다.

요청

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

메서드	URI
POST	/permission-sets/{permissionSetId}/exists-policy

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`permissionSetId`	String (uuid)	Required	Permission Set 아이디 <예시> 5e6f7081-5555-4ef0-8123-456789abcdef

요청 바디

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

필드	타입	필수 여부	설명
`policyName`	String	Required	사용자 정의 정책(User Created) 이름 <예시> example-policy

요청 예시

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v2/permission-sets/5e6f7081-5555-4ef0-8123-456789abcdef/exists-policy' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "policyName": "example-policy"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`success`	Boolean	-	API 처리 결과 `true` \| `false` true: Permission Set이 할당된 계정이 존재하지 않거나 대상 계정에 사용자 정의 정책 존재 false: Permission Set이 할당된 계정이 존재하지만 대상 계정에 사용자 정의 정책이 존재하지 않음 <예시> true
`accountsWithoutPolicy`	List<AccountV2>	-	사용자 정의 정책이 존재하지 않는 계정 목록. success가 false인 경우 표시

AccountV2

계정 정보

필드	타입	필수 여부	설명
`accountName`	String	-	계정 사용자 이름 <예시> example-account
`accountAlias`	String	-	계정 별칭 <예시> example-account
`accountLoginId`	String (email)	-	계정 로그인 아이디 <예시> user@example.com
`accountType`	String	-	계정 유형 `MASTER` \| `MEMBER` \| `NONE` MASTER: 마스터 계정 MEMBER: 멤버 계정 NONE: Organization에 속하지 않은 계정 <예시> MASTER
`accountGroup`	String	-	계정 그룹 <예시> example-group
`accountMemberNo`	Integer (int64)	-	계정 회원 번호(MemberNo) <예시> 1234567

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	요청 처리 성공
404	NotFound	One or more of the resources in the request does not exist in the system.	잘못된 URL 요청, 마스터 계정에 Organization이 존재하지 않음, 존재하지 않는 관리형 정책(System Managed) 아이디 입력, SSO User에 MFA Device가 존재하지 않음
404	ResourceNotFound	The specified resource could not be found.	생성된 Tenant가 없음, 존재하지 않는 자원 아이디 입력
404	PermissionSetNotFound	The specified permission set could not be found.	존재하지 않는 Permission Set 아이디 입력

응답 예시

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

{
  "success": true,
  "accountsWithoutPolicy": [
    {
      "accountName": "example-account",
      "accountAlias": "example-account",
      "accountLoginId": "user@example.com",
      "accountType": "MASTER",
      "accountGroup": "example-group",
      "accountMemberNo": 1234567
    }
  ]
}