OpenAI
ဤစာမျက်နှာကို စက်ဖြင့် ဘာသာပြန်ထားပါသည်။ မူရင်း အင်္ဂလိပ်ဆောင်းပါးကို ကြည့်ရန်။

Management API ရှိ EKM (External Keys)

Management API ကို အသုံးပြု၍ EKM အတွက် ပြင်ပသော့များ စီမံခန့်ခွဲနည်းကို လေ့လာပါ။

အပ်ဒိတ်လုပ်ထားသည်- 15 days ago

အနှစ်ချုပ်

ဝင်ရောက်အသုံးပြုခြင်း

  • Admin API သော့ဖြင့် Management API ရှိ EKM အဆုံးမှတ်များကို ဝင်ရောက်အသုံးပြုနိုင်သည်။ https://platform.openai.com/settings/organization/admin-keys (ပုံမှန် API သော့ကို မသုံးပါနှင့်)။ အဖွဲ့အစည်းပိုင်ရှင်များသည် Admin API သော့များကို ရယူနိုင်သည်။

  • ပြင်ပသော့များ ဖန်တီးရန် သို့မဟုတ် ဖျက်ရန် api.external_keys.write ကို အသုံးပြုပြီး ပြင်ပသော့များကို စာရင်းပြုစုရန် သို့မဟုတ် မှန်ကန်မှုစစ်ဆေးရန် api.external_keys.read ကို အသုံးပြုပါ။ သော့တစ်ခုသည် ဖတ်ခြင်းနှင့် ရေးခြင်း နှစ်မျိုးလုံး လုပ်ဆောင်ရန်လိုမှသာ ခွင့်ပြုချက်နယ်ပယ် နှစ်ခုလုံး လိုအပ်သည်။

  • လက်ရှိတွင် သင့်အဖွဲ့အစည်းက ဤအဆုံးမှတ်များကို အသုံးပြုနိုင်ရန် ကျွန်ုပ်တို့ဘက်မှ feature flag ဖွင့်ပေးရန် လိုအပ်သည်။ ရှိပြီးသား ပရောဂျက်စာရင်းရယူသည့် အဆုံးမှတ် https://api.openai.com/v1/organization/projects မှ external_key_id ကို ပြန်ပေးလာပါက feature flag ဖွင့်ထားပြီးဖြစ်ကြောင်း သိနိုင်သည်။

အသုံးပြုပုံ

  • သင့် EKM ဖွဲ့စည်းသတ်မှတ်ချက်ကို အဆုံးမှတ်အသစ် https://api.openai.com/v1/organization/external_keys မှတစ်ဆင့် အဖွဲ့အစည်းအဆင့်တွင် မှတ်ပုံတင်သည်။

  • သင့် EKM ဖွဲ့စည်းသတ်မှတ်ချက်ကို မှတ်ပုံတင်သောအခါ extkey_xxxx ပုံစံဖြင့် external_key_id ကို ပြန်ပေးသည်။

  • ရှိပြီးသား ပရောဂျက်ဖန်တီးသည့် အဆုံးမှတ် https://api.openai.com/v1/organization/projects ၏ တောင်းဆိုချက်ကိုယ်ထည်တွင် external_key_id ကို ထည့်ပေးခြင်းဖြင့် EKM ဖွဲ့စည်းသတ်မှတ်ချက်များကို ပရောဂျက်အဆင့်တွင် စတင်အသုံးပြုနိုင်အောင် ဖွင့်သည်။

ကန့်သတ်ချက်များ

  • Management API မှတစ်ဆင့် ပရောဂျက်အသစ်တစ်ခုတွင် EKM ကို ဦးစွာ စမ်းသပ်ရမည်။

  • သင့် EKM လုပ်ငန်းများအတွက် ပရောဂျက်အသစ်များ ဖန်တီးရန် အကြံပြုပါသည်။ သို့သော် ရှိပြီးသားပရောဂျက်တစ်ခုတွင် EKM အသုံးပြုလိုပါက သင့်အတွက် feature flag ဖွင့်ပေးနိုင်ပါသည်။ လက်ရှိ လက်တွေ့အသုံးပြုနေသော ပရောဂျက်များတွင် EKM စတင်မသုံးမီ အောက်ပါ အကောင်းဆုံးလုပ်ထုံးလုပ်နည်းများကို သတိပြုပါ။

    • လက်တွေ့အသုံးပြုနေသော API လုပ်ဆောင်ချက်အားလုံးကို စမ်းသပ်ရန် သတ်မှတ်ထားသည့် သင့် EKM API ပရောဂျက်တွင် ဦးစွာ စမ်းသပ်ပါ။

    • လက်တွေ့အသုံးပြုနေသော API ပရောဂျက်အားလုံးတွင် EKM ကို တစ်ပြိုင်နက် မထည့်သွင်းဘဲ အဆင့်ဆင့် ဖြန့်ချိအသုံးပြုပါ။

Organization အဆင့် endpoints

သင့်အဖွဲ့အစည်းတွင် ပြင်ပကီးတစ်ခု မှတ်ပုံတင်ရန်

AWS

တောင်းဆိုချက် နမူနာ:

  • type: string - အမြဲတမ်း “aws” ဖြစ်ရမည်

  • name: string - သင့်ဖွဲ့စည်းသတ်မှတ်ချက်အတွက် မှတ်မိလွယ်သောအမည်

  • role_arn: string - သင့် cloud တွင် OpenAI က ရယူအသုံးပြုမည့် အခန်းကဏ္ဍ၏ ARN

  • kms_arn: string - သင်စီမံခန့်ခွဲသည့် ပင်မသော့အတွက် သော့စီမံခန့်ခွဲမှုစနစ်၏ ARN

  • external_id: string - သင့်အဖွဲ့အစည်း ID သို့မဟုတ် API ပရောဂျက် ID

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
  "type": "aws",
  "name": "AWS EKM Config",
  "role_arn": "arn:aws:iam::<12_DIGIT_ACCOUNT_NUMBER>:role/<ROLE>",
  "kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
  "external_id": "<your org id or project id>"
}'

တုံ့ပြန်ချက် နမူနာ:

{
  "id": "extkey_xxxx",
  "object": "organization.external_key",
  "created_at": 1746175499,
  "api_project_ids": [],
  "type": "aws",
  "name": "AWS EKM Config",
  "role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>",
  "kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
  "external_id": "<your org id or project id>"
}

GCP

တောင်းဆိုချက် နမူနာ:

  • type: string - အမြဲတမ်း "gcp" ဖြစ်ရမည်၊

  • name: string - သင့်ဖွဲ့စည်းသတ်မှတ်ချက်အတွက် မှတ်မိလွယ်သောအမည်

  • workload_identity_project_number: string - OpenAI ၏ workload identity ကို သင်မှတ်ပုံတင်ထားသည့် GCP ပရောဂျက်၏ ကိန်းဂဏန်းဖြင့် ဖော်ပြသော နံပါတ်

  • workload_identity_pool_id: string - OpenAI အတွက် သင်မှတ်ပုံတင်ထားသော Workload Identity ပံ့ပိုးသူ ပါဝင်သည့် pool

  • workload_identity_provider_id: string - OpenAI အတွက် သင်မှတ်ပုံတင်ထားသော Workload Identity ပံ့ပိုးသူ

  • audience: string - သင့် GCP STS မှတစ်ဆင့် အခန်းကဏ္ဍတစ်ခုကို ရယူအသုံးပြုသည့်အခါ OpenAI က တိုကင်တွင် ထည့်ပေးရမည့် လက်ခံသူ

  • kms_project_id: string - သင့် KMS တည်ရှိသည့် GCP ပရောဂျက်၏ အမည်

  • kms_key_ring_name: string - သင်စီမံခန့်ခွဲသည့် ပင်မသော့ ပါဝင်သော သော့စီမံခန့်ခွဲမှုစနစ်၏ သော့အစု

  • kms_key_name: string - သော့စီမံခန့်ခွဲမှုစနစ်၏ ပင်မသော့အမည်

  • kms_key_location: string - သင့်သော့စီမံခန့်ခွဲမှုစနစ်၏ ပင်မသော့ တည်ရှိသည့် ဒေသ

သင့် KMS သည် OpenAI ၏ Workload Identity ကို မှတ်ပုံတင်ထားသော GCP ပရောဂျက်နှင့် မတူသည့် ပရောဂျက်တွင် ရှိနေပါက https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview သို့ သွားပြီး OpenAI ၏ Workload Identity ပါဝင်သည့် ပရောဂျက်တွင် အနည်းဆုံး KMS ကို ဖွင့်ထားကြောင်း သေချာစေပါ။

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
  "type": "gcp",
  "name": "GCP EKM Config",
  "workload_identity_project_number": "123456789012",
  "workload_identity_pool_id": "openai-azure",
  "workload_identity_provider_id": "openai-ekm-service-role",
  "audience": "<your org id or project id>",
  "kms_project_id": "adjective-noun-12345",
  "kms_key_name": "openai-kms-key",
  "kms_key_ring_name": "openai-kms-key-ring",
  "kms_key_location": "us-east1"
}'

တုံ့ပြန်ချက် နမူနာ:

{
  "id": "extkey_xxxxxx",
  "object": "organization.external_key",
  "created_at": 1746174349,
  "api_project_ids": [],
  "type": "gcp",
  "name": "GCP EKM Config",
  "workload_identity_project_number": "123456789012",
  "kms_key_ring_name": "openai-kms-key-ring",
  "kms_key_name": "openai-kms-key",
  "kms_key_location": "us-east1",
  "audience": "<your org id or project id>",
  "kms_project_id": "adjective-noun-12345",
  "workload_identity_pool_id": "openai-azure",
  "workload_identity_provider_id": "openai-ekm-service-role"
}

Azure

တောင်းဆိုချက် နမူနာ:

  • type: string - အမြဲတမ်း "azure" ဖြစ်ရမည်၊

  • name: string - သင့်ဖွဲ့စည်းသတ်မှတ်ချက်အတွက် မှတ်မိလွယ်သောအမည်

  • tenant_id: string - သင့် Azure tenant ၏ UUID

  • vault_uri: string - သင်စီမံခန့်ခွဲသည့် ပင်မသော့ ပါဝင်သော Azure vault ၏ URI

  • key_name: string - သင်စီမံခန့်ခွဲသည့် Azure Key Vault ပင်မသော့၏ အမည်။

    • ၎င်းသည် <org-xxx>--<any_name> ပုံစံဖြစ်ရမည်

    • ဤနေရာတွင် org-xxx သည် သင့် OpenAI အဖွဲ့အစည်း ID ဖြစ်ပြီး https://platform.openai.com/settings/organization/general တွင် ရှာနိုင်သည်

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
  "type": "azure",
  "name": "Azure EKM Config",
  "tenant_id": "<UUID>",
  "vault_uri": "https://<VAULT_NAME>.vault.azure.net/",
  "key_name": "org-xxx--some-key"
}'

တုံ့ပြန်ချက် နမူနာ:

{
  "id": "extkey_xxxx",
  "object": "organization.external_key",
  "created_at": 1746174377,
  "api_project_ids": [],
  "type": "azure",
  "name": "Azure EKM Config",
  "tenant_id": "<UUID>",
  "vault_uri": "https://<VAULT_NAME>.vault.azure.net/",
  "key_name": "org-xxx--some-key"
}

သင့်အဖွဲ့အစည်းတွင် မှတ်ပုံတင်ထားသော ပြင်ပသော့တစ်ခုကို ဖျက်ခြင်း

မှတ်ချက်: ပြင်ပသော့တစ်ခုသည် အသုံးပြုဆဲ API ပရောဂျက် သို့မဟုတ် အလုပ်နေရာတစ်ခုခုနှင့် ချိတ်ဆက်မထားမှသာ ၎င်းကို ဖျက်နိုင်သည်။ အသုံးပြုဆဲ API ပရောဂျက်တစ်ခုနှင့် ချိတ်ဆက်ထားပါက ထိုပရောဂျက်ကို ဦးစွာ မော်ကွန်းတင်ပါ။ အလုပ်နေရာတစ်ခုနှင့် ချိတ်ဆက်ထားပါက သော့ကို ဖျက်၍မရပါ။

တောင်းဆိုချက် နမူနာ

curl -X DELETE \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxxx"

တုံ့ပြန်ချက် နမူနာ

{
  "id": "extkey_xxxxx",
  "object": "organization.external_key.deleted",
  "created_at": 1746127808,
  "api_project_ids": [],
  "type": "aws",
  "account_number": "123456789012",
  "kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
  "name": "AWS EKM Config",
  "role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>"
}

သင့်အဖွဲ့အစည်းတွင် မှတ်ပုံတင်ထားသော ပြင်ပသော့များကို ရယူခြင်း

တောင်းဆိုချက် နမူနာ

curl -X GET \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys"

တုံ့ပြန်ချက် နမူနာ

{
  "object": "list",
  "data": [
    {
      "id": "extkey_xxxx",
      "object": "organization.external_key",
      "created_at": 1746127808,
      "api_project_ids": [],
      "type": "aws",
      "name": "AWS EKM Config",
      "account_number": "123456789012",
      "kms_arn": "arn:aws:kms:<REGION>:<ACCOUNT_NUMBER>:key/<UUID>",
      "role_arn": "arn:aws:iam::<ACCOUNT_NUMBER>:role/<ROLE>"
    }
  ],
  "first_id": "extkey_xxxx",
  "has_more": false,
  "last_id": "extkey_xxxx"
}

ပြင်ပသော့တစ်ခု၏ မှန်ကန်မှုကို စစ်ဆေးခြင်း

အောက်ပါအချက်များကို စစ်ဆေးရန် ဤအဆုံးမှတ်ကို အသုံးပြုနိုင်သည်:

  • သင်ပြောင်းလဲမှုများ ပြုလုပ်ပြီးနောက် သင့်ပြင်ပ cloud ဖွဲ့စည်းသတ်မှတ်ချက်သည် OpenAI နှင့် ဆက်လက်အသုံးပြုနိုင်ခြင်း ရှိမရှိ (အောင်မြင်ကြောင်း တုံ့ပြန်ချက်ကို တွေ့ရမည်)။

  • သင့်သော့ရုပ်သိမ်းမှုကို မှန်ကန်စွာ လုပ်ဆောင်ထားပြီး OpenAI က စီမံဆောင်ရွက်နေကာ cache ၏ ၁ နာရီ သက်တမ်း (TTL) များ ကုန်ဆုံးပြီးနောက် အကျိုးသက်ရောက်မည် ဟုတ်မဟုတ် (အမှားတုံ့ပြန်ချက်ကို တွေ့ရမည်)။

တောင်းဆိုချက် နမူနာ

curl -X POST -H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxx/validate"

တုံ့ပြန်ချက် နမူနာ

{
  "status": "success"
}

သို့မဟုတ် cloud provider မှ error တစ်ခု ပြန်လာသည်။

Project အဆင့် endpoints

ပြင်ပသော့ ID ဖြင့် ပရောဂျက်အသစ်တစ်ခု ဖန်တီးခြင်း

ဤအဆုံးမှတ်သည် ရှိပြီးသား ပရောဂျက်ဖန်တီးသည့် အဆုံးမှတ်နှင့် တူညီပြီး တောင်းဆိုချက်နှင့် တုံ့ပြန်ချက်တွင် external_key_id ပါရာမီတာကိုသာ ထပ်ဖြည့်ထားသည်။

တောင်းဆိုချက် နမူနာ

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects" \
-d '{
  "name": "Some Project",
  "external_key_id": "extkey_xxxx"
}'

တုံ့ပြန်ချက် နမူနာ

{
  "object": "organization.project",
  "id": "proj_xxxxx",
  "name": "Some Project",
  "external_key_id": "extkey_xxxx",
  "created_at": 1740012721,
  "archived_at": null,
  "status": "active"
}

[အသုံးပြုခွင့် ကန့်သတ်ထားသည်] ရှိပြီးသားပရောဂျက်တစ်ခုတွင် ပြင်ပသော့ ID ထည့်သွင်း၍ အပ်ဒိတ်လုပ်ခြင်း

ဤအဆုံးမှတ်သည် ရှိပြီးသား ပရောဂျက်အပ်ဒိတ်လုပ်သည့် အဆုံးမှတ်နှင့် တူညီပြီး တောင်းဆိုချက်နှင့် တုံ့ပြန်ချက်တွင် external_key_id ပါရာမီတာကိုသာ ထပ်ဖြည့်ထားသည်။

သင့် EKM လုပ်ငန်းများအတွက် API ပရောဂျက်အသစ်များ ဖန်တီးရန် အကြံပြုပါသည်။ သင့်ရှိပြီးသား API ပရောဂျက်အားလုံးတွင် EKM အသုံးပြုလိုပါက သင့်အကောင့်တာဝန်ခံ ဒါရိုက်တာထံ တောင်းဆိုပါ။ သင့်အတွက် feature flag ဖွင့်ပေးပါမည်။ လက်ရှိ လက်တွေ့အသုံးပြုနေသော ပရောဂျက်များတွင် EKM စတင်မသုံးမီ အောက်ပါ အကောင်းဆုံးလုပ်ထုံးလုပ်နည်းများကို သတိပြုပါ။

  • လက်တွေ့အသုံးပြုနေသော API လုပ်ဆောင်ချက်အားလုံးကို သင့်စမ်းသပ်မှု용 EKM API ပရောဂျက်တွင် ဦးစွာ စမ်းသပ်ပါ။

  • လက်တွေ့အသုံးပြုနေသော API ပရောဂျက်အားလုံးတွင် EKM ကို တစ်ပြိုင်နက် မထည့်သွင်းဘဲ အဆင့်ဆင့် ဖြန့်ချိအသုံးပြုပါ။

တောင်းဆိုချက် နမူနာ

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects/proj_xxx" \
-d '{
  "external_key_id": "extkey_xxxx"
}'

သင့်အဖွဲ့အစည်းရှိ ပရောဂျက်အားလုံးကို စာရင်းပြုစုခြင်း

ဤအဆုံးမှတ်သည် ရှိပြီးသားအဆုံးမှတ်နှင့် တူညီပြီး API တုံ့ပြန်ချက်တွင် external_key_id ကိုသာ ထပ်ဖြည့်ထားသည်။

တောင်းဆိုချက် နမူနာ

curl -X GET \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/projects"

တုံ့ပြန်ချက် နမူနာ

{
  "object": "list",
  "data": [
    {
      "object": "organization.project",
      "id": "proj_xxxx",
      "name": "Project Name",
      "external_key_id": "extkey_xxxx",
      "created_at": 1717798982,
      "archived_at": null,
      "status": "active"
    }
  ],
  "first_id": "proj_xxxx",
  "last_id": "proj_xxxx",
  "has_more": true
}

ဤဆောင်းပါးသည် အထောက်အကူ ဖြစ်ပါသလား။