1 つの組織サービス アカウントを作成
指定された組織に対して 1 つのサービス アカウントを作成します。
path パラメータ
-
24プロジェクトを含む組織を識別する一意の 桁の 16 進数文字列。認証済みユーザーがアクセスできるすべての組織を取得するには、 /orgs エンドポイントを使用します。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint
body
必須
新しいサービス アカウントの詳細。
-
サービス アカウントの人間が判読可能な説明。
最小長は
1
、最大長は250
です。形式は次のパターンと一致する必要があります:^[\p{L}\p{N}\-_.,' ]*$
。 -
人間が判読可能なサービス アカウントの名前。 名前は変更可能であり、一意である必要はありません。
最小長は
1
、最大長は64
です。形式は次のパターンと一致する必要があります:^[\p{L}\p{N}\-_.,' ]*$
。 -
サービス アカウントの組織レベルのロールの一覧。
少なくとも
1
要素。値は、ORG_MEMBER
、ORG_READ_ONLY
、ORG_BILLING_ADMIN
、ORG_BILLING_READ_ONLY
、ORG_STREAM_PROCESSING_ADMIN
、ORG_GROUP_CREATOR
、またはORG_OWNER
です。 -
新しいサービス アカウント シークレットの有効期限は時間単位で指定されます。最小および最大の許可された有効期限は変更される可能性があり、組織の設定によって制御されます。
atlas api serviceAccounts createOrgServiceAccount --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20241023001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateOrgServiceAccountApiParams{}
sdkResp, httpResp, err := client.ServiceAccountsApi.
CreateOrgServiceAccountWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2024-10-23+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/orgs/{orgId}/serviceAccounts" \
-d '{ <Payload> }'
{
"description": "string",
"name": "string",
"roles": [
"ORG_MEMBER"
],
"secretExpiresAfterHours": 8
}
{
"clientId": "mdb_sa_id_1234567890abcdef12345678",
"createdAt": "2025-05-04T09:42:00Z",
"description": "string",
"name": "string",
"roles": [
"ORG_MEMBER"
],
"secrets": [
{
"createdAt": "2025-05-04T09:42:00Z",
"expiresAt": "2025-05-04T09:42:00Z",
"id": "32b6e34b3d91647abb20e7b8",
"lastUsedAt": "2025-05-04T09:42:00Z",
"maskedSecretValue": "mdb_sa_sk_...",
"secret": "mdb_sa_sk_..."
}
]
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}