listAssignments

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

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

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

Assignment 목록을 조회합니다. 결과는 생성 일시 내림차순으로 정렬됩니다.

요청

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

메서드	URI
GET	/assignments

요청 헤더

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

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`pageNo`	Integer (int32)	Optional	페이지 번호 범위: 0 ~ 1,000,000 기본값: 0 <예시> 0
`pageSize`	Integer (int32)	Optional	페이지당 항목 수 범위: 1 ~ 100 기본값: 20 <예시> 20

요청 예시

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

curl --location --request GET 'https://sso.apigw.ntruss.com/api/v2/assignments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`totalElements`	Integer (int64)	-	전체 항목 수 <예시> 2
`totalPages`	Integer (int32)	-	전체 페이지 수 <예시> 1
`pageNo`	Integer (int32)	-	현재 페이지 번호 <예시> 0
`pageSize`	Integer (int32)	-	페이지당 항목 수 <예시> 20
`assignments`	List<AssignmentListItemV2>	-	Assignment 목록

AssignmentListItemV2

Assignment 목록 항목

필드	타입	필수 여부	설명
`assignmentId`	String (uuid)	-	Assignment 아이디 <예시> 3c4d5e6f-3333-4cde-8f01-23456789abcd
`assignmentName`	String	-	Assignment 이름 <예시> example-assignment
`description`	String	-	Assignment 설명 <예시> example description
`nrn`	String	-	Assignment에 대한 네이버 클라우드 플랫폼 리소스 식별 값 <예시> nrn:PUB:SSO::1234567:Assignment/3c4d5e6f-3333-4cde-8f01-23456789abcd
`status`	String	-	Assignment 상태 `ACTIVATED` \| `SUSPENDED` \| `DELETED` ACTIVATED: 사용 중(활성화) SUSPENDED: 정지(비활성화) DELETED: 삭제됨 <예시> ACTIVATED
`iamRoleNrn`	String	-	Sub Account 서비스에 생성된 SSO 역할 NRN <예시> nrn:PUB:IAM::1234567:Role/385550d0-1111-4abc-8def-005056a79baa
`consoleAccessAllowed`	Boolean	-	콘솔 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true
`consoleAccessRestricted`	Boolean	-	콘솔 접근 제한 여부 `true` \| `false` true: 제한 false: 제한 안 함 <예시> true
`apiAccessAllowed`	Boolean	-	API Gateway 접근 허용 여부 `true` \| `false` true: 허용 false: 허용 안 함 <예시> true
`apiAccessRestricted`	Boolean	-	API Gateway 접근 제한 여부 `true` \| `false` true: 제한 false: 제한 안 함 <예시> true
`createdDateTime`	String (date-time)	-	Assignment 생성 일시 <예시> 2025-01-02T09:00:00Z
`updatedDateTime`	String (date-time)	-	Assignment 최종 수정 일시 <예시> 2025-01-02T09:00:00Z
`accountMemberNo`	Integer (int64)	-	계정 회원 번호(MemberNo) <예시> 1234567
`accountName`	String	-	계정 사용자 이름 <예시> example-account
`accountAlias`	String	-	계정 별칭. Organization 연동 계정인 경우 표시 <예시> example-account
`permissionSetId`	String (uuid)	-	Permission Set 아이디 <예시> 5e6f7081-5555-4ef0-8123-456789abcdef

응답 상태 코드

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가 없음, 존재하지 않는 자원 아이디 입력

응답 예시

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

{
  "totalElements": 2,
  "totalPages": 1,
  "pageNo": 0,
  "pageSize": 20,
  "assignments": [
    {
      "assignmentId": "3c4d5e6f-3333-4cde-8f01-23456789abcd",
      "assignmentName": "example-assignment",
      "description": "example description",
      "nrn": "nrn:PUB:SSO::1234567:Assignment/3c4d5e6f-3333-4cde-8f01-23456789abcd",
      "status": "ACTIVATED",
      "iamRoleNrn": "nrn:PUB:IAM::1234567:Role/385550d0-1111-4abc-8def-005056a79baa",
      "consoleAccessAllowed": true,
      "consoleAccessRestricted": true,
      "apiAccessAllowed": true,
      "apiAccessRestricted": true,
      "createdDateTime": "2025-01-02T09:00:00Z",
      "updatedDateTime": "2025-01-02T09:00:00Z",
      "accountMemberNo": 1234567,
      "accountName": "example-account",
      "accountAlias": "example-account",
      "permissionSetId": "5e6f7081-5555-4ef0-8123-456789abcdef"
    }
  ]
}