addGroupTags

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

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

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

그룹에 태그를 추가합니다.

요청

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

메서드	URI
POST	/groups/{groupId}/add-tags

요청 헤더

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

요청 경로 파라미터

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

필드	타입	필수 여부	설명
`groupId`	String (uuid)	Required	그룹 아이디 <예시> 2b3c4d5e-2222-4bcd-9ef0-123456789abc

요청 바디

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

필드	타입	필수 여부	설명
`tagKey`	String	Required	태그 키 패턴: `^[A-Za-z0-9_./=+\-@]+$` 길이: ~ 128 <예시> env
`tagValue`	String	Required	태그 값 패턴: `^[A-Za-z0-9_./=+\-@]+$` 길이: ~ 256 <예시> prod

요청 예시

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

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v2/groups/2b3c4d5e-2222-4bcd-9ef0-123456789abc/add-tags' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '{
  "tagKey": "env",
  "tagValue": "prod"
}'

응답

응답 형식을 설명합니다.

응답 바디

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

그룹에 태그 추가 결과. 이 API는 success 만 채워 반환하며 id·name·nrn·message 는 생략됩니다.

필드	타입	필수 여부	설명
`id`	String	-	처리된 리소스 아이디 <예시> 1a2b3c4d-1111-4abc-8def-0123456789ab
`name`	String	-	처리된 리소스 이름 <예시> example-name
`nrn`	String	-	처리된 리소스 NRN <예시> nrn:PUB:SSO::1234567:User/1a2b3c4d-1111-4abc-8def-0123456789ab
`success`	Boolean	-	API 처리 결과 `true` \| `false` true: 처리 성공. 처리 실패가 에러 응답(4xx)으로 반환되는 오퍼레이션에서는 항상 true false: 검증 결과를 반환하는 오퍼레이션에서 검증 실패. 사유는 message 에 담깁니다 <예시> true
`message`	String	-	결과 메시지 <예시> success

응답 상태 코드

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

이 API에만 해당하는 응답 상태 코드는 다음과 같습니다.

HTTP 상태 코드	코드	메시지	설명
200	-	-	요청 처리 성공. 응답 본문은 success 만 포함
400	TagLimitExceeded	The maximum allowed number of tags was exceeded.	리소스당 태그 수(20개) 초과
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	GroupNotFound	The specified group could not be found.	존재하지 않는 그룹 아이디 입력

응답 예시

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

{
  "id": "1a2b3c4d-1111-4abc-8def-0123456789ab",
  "name": "example-name",
  "nrn": "nrn:PUB:SSO::1234567:User/1a2b3c4d-1111-4abc-8def-0123456789ab",
  "success": true,
  "message": "success"
}