Assignment 조회

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

요청

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

메서드	URI
GET	/api/v1/assignments/{assignmentId}

요청 헤더

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

요청 경로 파라미터

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

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

요청 예시

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

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

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`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	-	계정 사용자 이름
`accountAlias`	String	-	계정 별칭
`accountGroup`	String	-	계정 그룹
`accountType`	String	-	계정 유형 `Master` \| `Member` `Master`: 마스터 계정 `Member`: 멤버 계정
`accountLoginId`	String	-	계정 로그인 아이디
`permissionSetId`	String	-	Permission Set 아이디
`permissionSetName`	String	-	Permission Set 이름
`permissionSetNrn`	String	-	Permission Set에 대한 네이버 클라우드 플랫폼 리소스 식별 값
`permissionSetDescription`	String	-	Permission Set 설명
`permissionCreatedAt`	String	-	Permission Set 생성 일시 ISO 8601 형식

응답 상태 코드

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

응답 예시

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

{
  "assignmentId" : "e1653f17-****-****-****-deb664fb8a2f",
  "assignmentName" : "assignment000",
  "description" : "assignment description",
  "nrn" : "nrn:PUB:SSO::*******:Assignment/e1653f17-****-****-****-deb664fb8a2f",
  "status" : "active",
  "iamRoleNrn" : "nrn:PUB:IAM::*******:Role/385550d0-****-****-****-005056a79baa",
  "consoleAccessAllowed" : true,
  "consoleAccessRestricted" : false,
  "apiAccessAllowed" : true,
  "apiAccessRestricted" : false,
  "createdAt" : "2025-01-13T02:36:40Z",
  "updatedAt" : "2025-01-13T02:36:40Z",
  "accountMbrNo" : *******,
  "accountName" : "홍길동",
  "accountAlias" : "-",
  "accountGroup" : "-",
  "accountType" : "-",
  "accountLoginId" : "******@ncloud.com",
  "permissionSetId" : "3fcd3c17-****-****-****-2a594248bf28",
  "permissionSetName" : "permissionset000",
  "permissionSetNrn" : "nrn:PUB:SSO::*******:PermissionSet/3fcd3c17-****-****-****-2a594248bf28",
  "permissionSetDescription" : "permissionset000 description",
  "permissionCreatedAt" : "2025-01-03T02:26:47Z"
}