SSO User Assignment 목록 조회

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

SSO User가 속한 Assignment 목록을 조회합니다.

요청

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

메서드	URI
GET	/api/v1/users/{userId}/assignments

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`userId`	String	Required	SSO User 아이디 SSO User 목록 조회 참조

요청 쿼리 파라미터

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

필드	타입	필수 여부	설명
`page`	Integer	Optional	페이지 번호 0~N (기본값: 0)
`size`	Integer	Optional	페이지 출력 수 1~N (기본값: 20)

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`page`	Number	-	페이지 번호
`totalPages`	Number	-	전체 페이지 수
`totalItems`	Number	-	응답 결과 수
`isFirst`	Boolean	-	첫 페이지 여부 `true` \| `false` `true`: 첫 페이지 `false`: 첫 페이지 아님
`isLast`	Boolean	-	마지막 페이지 여부 `true` \| `false` `true`: 마지막 페이지 `false`: 마지막 페이지 아님
`hasPrevious`	Boolean	-	이전 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`hasNext`	Boolean	-	다음 페이지 존재 여부 `true` \| `false` `true`: 존재 `false`: 존재 안 함
`items`	Array	-	Assignment 목록

`items`

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

필드	타입	필수 여부	설명
`assignmentId`	String	-	Assignment 아이디
`assignmentName`	String	-	Assignment 이름
`description`	String	-	Assignment 설명
`nrn`	String	-	Assignment에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`status`	String	-	Assignment 상태 `active` \| `suspended` `active`: 사용 중(활성화) `suspended`: 정지(비활성화)
`iamRoleNrn`	String	-	Sub Account 서비스에 생성된 SSO 역할 NRN IAM role에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`consoleAccessAllowed`	Boolean	-	콘솔 접근 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함
`consoleAccessRestricted`	Boolean	-	콘솔 접근 제한 여부 `true` \| `false` `true`: 제한 `false`: 제한 안 함
`apiAccessAllowed`	Boolean	-	API Gateway 접근 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함
`apiAccessRestricted`	Boolean	-	API Gateway 접근 제한 여부 `true` \| `false` `true`: 제한 `false`: 제한 안 함
`createdAt`	String	-	Assignment 생성 일시 ISO 8601 형식
`updatedAt`	String	-	Assignment 최종 수정 일시 ISO 8601 형식
`accountMbrNo`	Number	-	계정 회원 번호(MemberNo)
`accountName`	String	-	계정 사용자 이름
`permissionSetId`	String	-	Permission Set 아이디

응답 상태 코드

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

응답 예시

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

{
    "page" : 0,
    "totalPages" : 1,
    "totalItems" : 1,
    "isFirst" : true,
    "isLast" : true,
    "hasPrevious" : false,
    "hasNext" : false,
    "items" : [
        {
            "assignmentId" : "b246f5f8-****-****-****-6718f2135c68",
            "assignmentName" : "assignment001",
            "description" : "assignment001 description",
            "nrn" : "nrn:PUB:SSO::*******:Assignment/b246f5f8-****-****-****-6718f2135c68",
            "status" : "active",
            "iamRoleNrn" : "nrn:PUB:IAM::*******:Role/c3d649e0-****-****-****-005056a7ecf2",
            "consoleAccessAllowed" : true,
            "consoleAccessRestricted" : false,
            "apiAccessAllowed" : true,
            "apiAccessRestricted" : false,
            "createdAt" : "2025-01-20T07:25:46Z",
            "updatedAt" : "2025-01-20T07:41:56Z",
            "accountMbrNo" : *******,
            "accountName" : "홍길동",
            "permissionSetId" : "63920339-****-****-****-aaf6c9ce927e"
        }
    ]
}