リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v1/groups

リクエストヘッダ

Ncloud Single Sign-On APIで共通して使用されるヘッダの詳細は、Ncloud Single Sign-Onのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`name`	String	Required	グループ名英数字、記号の「-」、「_」を組み合わせて2~30文字以内で入力先頭文字は英字または数字のみ使用作成後は変更不可
`description`	String	Optional	グループの説明 0~300文字

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://sso.apigw.ntruss.com/api/v1/groups' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "name": "group000",
    "description": "group000 description"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`groupId`	String	-	グループ ID
`groupName`	String	-	グループ名
`nrn`	String	-	グループに対する NAVERクラウドプラットフォームリソースの識別値
`description`	String	-	グループの説明
`createdAt`	String	-	グループの作成日時 ISO 8601形式
`updatedAt`	String	-	グループの更新日時 ISO 8601形式

レスポンスステータスコード

Ncloud Single Sign-On APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Single Sign-Onのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
    "groupId": "12cfbd94-****-****-****-2ff725201395",
    "groupName": "group000",
    "nrn": "nrn:PUB:SSO::*******:Group/12cfbd94-****-****-****-2ff725201395",
    "description": "group000 description",
    "createdAt": "2025-01-13T02:04:15Z",
    "updatedAt": "2025-01-13T02:04:15Z"
}

この記事は役に立ちましたか?

リクエスト
レスポンス