getPermissionSet

Prev Next

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

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

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

Permission Set의 상세 정보를 조회합니다.

요청

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

메서드 URI
GET /permission-sets/{permissionSetId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v2/permission-sets/5e6f7081-5555-4ef0-8123-456789abcdef' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드 타입 필수 여부 설명
permissionSetId String (uuid) - Permission Set 아이디
  • <예시> 5e6f7081-5555-4ef0-8123-456789abcdef
permissionSetName String - Permission Set 이름
  • <예시> example-permissionset
description String - Permission Set 설명
  • <예시> example description
nrn String - Permission Set에 대한 네이버 클라우드 플랫폼 리소스 식별 값
  • <예시> nrn:PUB:SSO::1234567:PermissionSet/5e6f7081-5555-4ef0-8123-456789abcdef
createdDateTime String (date-time) - Permission Set 생성 일시
  • <예시> 2025-01-02T09:00:00Z
systemManagedPolicies List<SystemManagedPolicyV2> - 관리형 정책(System Managed) 목록
userCreatedPolicies List<UserCreatedPolicy> - 사용자 정의 정책(User Created) 목록
accounts List<AccountV2> - 계정 목록

SystemManagedPolicyV2

시스템 관리형 정책(System Managed) 정보

필드 타입 필수 여부 설명
policyId String (uuid) - 관리형 정책(System Managed) 아이디
  • <예시> 8d9e0f10-8888-4123-9456-789abcdef012
policyName String - 관리형 정책(System Managed) 이름
  • <예시> example-policy
policyDescription String - 관리형 정책(System Managed) 설명
  • <예시> Permission to use all the features in Ncloud Single Sign-On
policyCreatedDateTime String (date-time) - 관리형 정책(System Managed) 생성 일시
  • <예시> 2025-01-02T09:00:00Z

UserCreatedPolicy

사용자 정의 정책(User Created) 정보

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

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 아이디 입력

응답 예시

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

{
  "permissionSetId": "5e6f7081-5555-4ef0-8123-456789abcdef",
  "permissionSetName": "example-permissionset",
  "description": "example description",
  "nrn": "nrn:PUB:SSO::1234567:PermissionSet/5e6f7081-5555-4ef0-8123-456789abcdef",
  "createdDateTime": "2025-01-02T09:00:00Z",
  "systemManagedPolicies": [
    {
      "policyId": "8d9e0f10-8888-4123-9456-789abcdef012",
      "policyName": "example-policy",
      "policyDescription": "Permission to use all the features in Ncloud Single Sign-On",
      "policyCreatedDateTime": "2025-01-02T09:00:00Z"
    }
  ],
  "userCreatedPolicies": [
    {
      "userCreatedPolicyName": "example-usercreatedpolicy"
    }
  ],
  "accounts": [
    {
      "accountName": "example-account",
      "accountAlias": "example-account",
      "accountLoginId": "user@example.com",
      "accountType": "MASTER",
      "accountGroup": "example-group",
      "accountMemberNo": 1234567
    }
  ]
}