Baro sida loo maamulo furayaasha dibadda ee EKM iyadoo la adeegsanayo API-ga Maamulka.

Soo koobid

Helitaanka

Bar-dhammaadyada EKM waxaa laga geli karaa API-ga Maamulka iyadoo la adeegsanayo Furaha API-ga Maamulaha. https://platform.openai.com/settings/organization/admin-keys (ha isticmaalin furaha API-ga ee caadiga ah). Furayaasha API-ga maamulaha waxaa heli kara milkiilayaasha ururka.
Isticmaal api.external_keys.write si aad u abuurto ama u tirtirto furayaasha dibadda, iyo api.external_keys.read si aad u taxdo ama u xaqiijiso furayaasha dibadda. Hal fure wuxuu labada oggolaansho u baahan yahay oo keliya haddii uu fulinayo hawlo akhris iyo qoraal labadaba.
Hadda waxaan u baahan nahay inaan ururkaaga u daarno calaamadda hawlgelinta si uu u isticmaalo bar-dhammaadyadan. Waxaad ogaan kartaa in calaamadda hawlgelinta laguu daaray haddii aad aragto external_key_id oo ka soo noqda bar-dhammaadka jira ee Tax Mashaariicda: https://api.openai.com/v1/organization/projects.

Isticmaalka

Habayntaada EKM waxaa laga diiwaangeliyaa heerka ururka iyadoo la marayo bar-dhammaadka cusub ee https://api.openai.com/v1/organization/external_keys.
Markaad diiwaangeliso habayntaada EKM, waxaa laguu soo celiyaa external_key_id oo qaabkiisu yahay extkey_xxxx.
Habaynnada EKM waxaa laga hawlgeliyaa heerka mashruuca iyadoo external_key_id lagu darayo jirka codsiga loo diro bar-dhammaadka jira ee Abuur Mashruuc https://api.openai.com/v1/organization/projects.

Xaddidaadaha

Waa inaad marka hore EKM ku tijaabisaa mashruuc cusub adigoo adeegsanaya API-ga Maamulka.
Waxaan kugula talinaynaa inaad mashaariic cusub u abuurto hawlahaaga EKM. Hase yeeshee, haddii aad rabto EKM mashruuc jira, waxaan kuu daari karnaa calaamadda hawlgelinta. Fadlan tixgeli hab-dhaqannadan wanaagsan ka hor intaadan EKM ku dabaqin mashaariicdaada jira ee adeegga dhabta ah ku shaqeeya.
- Marka hore ku tijaabi mashruucaaga API ee tijaabada EKM dhammaan sifooyinka API-ga ee aad u adeegsato adeegga dhabta ah.
- Si tartiib-tartiib ah u hirgeli EKM halkii aad hal mar ku wada dabaqi lahayd dhammaan mashaariicda API ee adeegga dhabta ah ku shaqeeya.

endpoints heerka ururka

Diiwaangeli fure dibadeed ururkaaga

AWS

Tusaale codsi:

type: xaraf-taxane - mar walba “aws”
name: xaraf-taxane - Magac si fudud loogu aqoonsado habayntaada
role_arn: xaraf-taxane - ARN-ka doorka ay OpenAI ku shaqayn doonto deegaankaaga daruurta
kms_arn: xaraf-taxane - ARN-ka Nidaamka Maamulka Furayaasha ee furaha guud ee aad maamusho
external_id: xaraf-taxane - Aqoonsiga Ururkaaga ama aqoonsiga mashruucaaga API

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>"
}'

Tusaale jawaab:

{
  "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

Tusaale codsi:

type: xaraf-taxane - mar walba “gcp”,
name: xaraf-taxane - Magac si fudud loogu aqoonsado habayntaada
workload_identity_project_number: xaraf-taxane - Lambarka tirooyinka ah ee mashruuca GCP ee aad ku diiwaangelisay aqoonsiga hawlaha OpenAI
workload_identity_pool_id: xaraf-taxane - Kooxda uu ku jiro bixiyaha Aqoonsiga Hawlaha ee aad u diiwaangelisay OpenAI
workload_identity_provider_id: xaraf-taxane - Bixiyaha Aqoonsiga Hawlaha ee aad u diiwaangelisay OpenAI
audience: xaraf-taxane - Cidda loogu talagalay oo ay tahay in OpenAI ku darto token-ka marka aan door ku qaadanno GCP STS-kaaga
kms_project_id: xaraf-taxane - Magaca mashruuca GCP ee KMS-kaagu ku jiro
kms_key_ring_name: xaraf-taxane - Xidhmada furayaasha ee Nidaamka Maamulka Furayaasha ee uu ku jiro furaha guud ee aad maamusho
kms_key_name: xaraf-taxane - Magaca furaha guud ee Nidaamka Maamulka Furayaasha
kms_key_location: xaraf-taxane - Gobolka uu ku yaal furahaaga guud ee Nidaamka Maamulka Furayaasha

Haddii KMS-kaagu ku jiro mashruuc GCP oo ka duwan kii aad ku diiwaangelisay Aqoonsiga Hawlaha OpenAI, hubi in ugu yaraan KMS laga hawlgeliyay mashruuca uu ku jiro Aqoonsiga Hawlaha OpenAI, adigoo booqanaya https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview.

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"
}'

Tusaale jawaab:

{
  "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

Tusaale codsi:

type: xaraf-taxane - mar walba “azure”,
name: xaraf-taxane - Magac si fudud loogu aqoonsado habayntaada
tenant_id: xaraf-taxane - UUID-ga deegaankaaga ururka ee Azure
vault_uri: xaraf-taxane - URI-ga khasnadda Azure ee uu ku jiro furaha guud ee aad maamusho
key_name: xaraf-taxane - Magaca furaha guud ee Azure Key Vault ee aad maamusho.
- Waa inuu lahaadaa qaabka <org-xxx>--<any_name>
- halka org-xxx uu yahay Aqoonsiga Ururkaaga OpenAI oo aad ka heli karto 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"
}'

Tusaale jawaab:

{
  "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"
}

Tirtir fure dibadeed oo ururkaaga ka diiwaangashan

Fiiro gaar ah: Fure dibadeed waad tirtiri kartaa oo keliya haddii aanu ku xirnayn mashruuc API oo firfircoon ama goobta shaqada. Haddii uu ku xiran yahay mashruuc API oo firfircoon, marka hore mashruucaas ku kaydi kaydka diiwaannada. Haddii uu ku xiran yahay goobta shaqada, furaha lama tirtiri karo.

Tusaale codsi

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

Tusaale jawaab

{
  "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>"
}

Soo hel furayaasha dibadda ee ururkaaga ka diiwaangashan

Tusaale codsi

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

Tusaale jawaab

{
  "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"
}

Xaqiiji fure dibadeed

Waxaad bar-dhammaadkan u isticmaali kartaa inaad ku hubiso dhowr arrimood:

In habaynta deegaankaaga daruurta ee dibaddu ay weli la shaqaynayso OpenAI ka dib isbeddellada aad samaysay (waxaad arki doontaa jawaab muujinaysa guul).
In burinta furahaaga si sax ah loo sameeyay, ay OpenAI ka shaqaynayso, ayna dhaqan geli doonto marka ay dhammaadaan muddada 1-saac ah ee xogtu ku jirto kaydka ku-meelgaarka ah (TTL) (waxaad arki doontaa jawaab muujinaysa khalad).

Tusaale codsi

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

Tusaale jawaab

{
  "status": "success"
}

Ama, qalad ka yimid bixiyaha daruuraha ayaa muuqday.

endpoints heerka mashruuca

Abuur mashruuc cusub oo leh aqoonsiga fure dibadeed

Kani wuxuu la mid yahay bar-dhammaadka jira ee Abuur Mashruuc, balse halbeegga external_key_id ayaa lagu daray codsiga iyo jawaabta.

Tusaale codsi

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"
}'

Tusaale jawaab

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

[Xaddidan] Ku cusboonaysii mashruuc jira aqoonsiga fure dibadeed

Kani wuxuu la mid yahay bar-dhammaadka jira ee Cusboonaysii Mashruuc, balse halbeegga external_key_id ayaa lagu daray codsiga iyo jawaabta.

Waxaan kugula talinaynaa inaad mashaariic API oo cusub u abuurto hawlahaaga EKM. Haddii aad rabto EKM dhammaan mashaariicdaada API ee jira, la xiriir agaasimaha akoonkaaga, annaguna waxaan kuu daari doonnaa calaamadda hawlgelinta. Fadlan tixgeli hab-dhaqannadan wanaagsan ka hor intaadan EKM ku dabaqin mashaariicdaada jira ee adeegga dhabta ah ku shaqeeya.

Marka hore ku tijaabi mashruucaaga API ee tijaabada EKM dhammaan sifooyinka API-ga ee aad u adeegsato adeegga dhabta ah.
Si tartiib-tartiib ah u hirgeli EKM halkii aad hal mar ku wada dabaqi lahayd dhammaan mashaariicda API ee adeegga dhabta ah ku shaqeeya.

Tusaale codsi

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"
}'

Tax dhammaan mashaariicda ururkaaga

Kani wuxuu la mid yahay bar-dhammaadka jira, balse external_key_id ayaa lagu daray jawaabta API-ga.

Tusaale codsi

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

Tusaale jawaab

{
  "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
}

EKM (Furayaasha Dibadda) ee Management API

Soo koobid

Helitaanka

Isticmaalka

Xaddidaadaha

endpoints heerka ururka

Diiwaangeli fure dibadeed ururkaaga

AWS

GCP

Azure

Tirtir fure dibadeed oo ururkaaga ka diiwaangashan

Tusaale codsi

Tusaale jawaab

Soo hel furayaasha dibadda ee ururkaaga ka diiwaangashan

Tusaale codsi

Tusaale jawaab

Xaqiiji fure dibadeed

Tusaale codsi

Tusaale jawaab

endpoints heerka mashruuca

Abuur mashruuc cusub oo leh aqoonsiga fure dibadeed

Tusaale codsi

Tusaale jawaab

[Xaddidan] Ku cusboonaysii mashruuc jira aqoonsiga fure dibadeed

Tusaale codsi

Tax dhammaan mashaariicda ururkaaga

Tusaale codsi

Tusaale jawaab

Maqaalkani faa'iido ma kuu lahaa?