Assignment 생성

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

Assignment를 생성합니다. Assignment는 외부 계정이 사용할 정책을 정의한 Permission Set과 SSO User를 연결한 것으로, SSO User가 네이버 클라우드 플랫폼에서 수행할 수 있는 권한 범위를 의미합니다.

요청

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

메서드	URI
POST	/api/v1/assignments

요청 헤더

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

요청 바디

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

필드	타입	필수 여부	설명
`assignmentName`	String	Required	Assignment 이름 영문자, 숫자, 특수문자 '-', '_'를 조합하여 2~30자로 입력 문자열의 시작은 영문자 또는 숫자로 구성 생성 후 변경 불가
`accountMbrNo`	Number	Required	계정 회원 번호(MemberNo)
`permissionSetId`	String	Required	Permission Set 아이디
`description`	String	Optional	Assignment 설명 0~300자
`consoleAccessAllowed`	Boolean	Required	콘솔 접근 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함
`apiAccessAllowed`	Boolean	Required	API Gateway 접근 허용 여부 `true` \| `false` `true`: 허용 `false`: 허용 안 함

요청 예시

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

curl --location --request POST 'https://sso.apigw.gov-ntruss.com/api/v1/assignments' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "assignmentName": "assignment000",
    "accountMbrNo": *******,
    "permissionSetId": "3fcd3c17-****-****-****-2a594248bf28",
    "description": "assignment description",
    "consoleAccessAllowed": true,
    "apiAccessAllowed": true
}'

응답

응답 형식을 설명합니다.

응답 바디

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

필드	타입	필수 여부	설명
`id`	String	-	Assignment 아이디
`success`	Boolean	-	API 처리 결과 `true` \| `false` `true`: 성공 `false`: 실패
`message`	String	-	결과 메시지 `success`가 `false`인 경우, 표시

응답 상태 코드

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

응답 예시

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

{
    "id": "e1653f17-****-****-****-deb664fb8a2f",
    "success": true
}