OpenAI
Aistríodh an leathanach seo le meaisín. Féach ar an t-alt bunaidh i mBéarla.

EKM (Eochracha Seachtracha) san API Bainistíochta

Foghlaim conas eochracha seachtracha le haghaidh EKM a bhainistiú leis an API Bainistíochta.

Nuashonraithe: 9 minutes ago

Achoimre

Rochtain

  • Tá deireadhphointí EKM inrochtana san API Bainistíochta trí Eochair API Riaracháin. https://platform.openai.com/settings/organization/admin-keys (ná húsáid gnátheochair API). Tá eochracha API riaracháin ar fáil d'úinéirí eagraíochta.

  • Úsáid api.external_keys.write chun eochracha seachtracha a chruthú nó a scriosadh, agus api.external_keys.read chun eochracha seachtracha a liostú, a aisghabháil nó a bhailíochtú. Ní theastaíonn an dá raon feidhme ó eochair aonair ach amháin más gá di oibríochtaí léitheoireachta agus scríbhneoireachta araon a dhéanamh.

Úsáid

Srianta

  • Ní mór duit EKM a thástáil ar thionscadal nua ar dtús tríd an API Bainistíochta.

  • Molaimid tionscadail nua a chruthú do d'ualaí oibre EKM. Tabhair aird ar na dea-chleachtais seo a leanas sula gcuireann tú EKM i bhfeidhm ar na tionscadail atá á n-úsáid agat i dtáirgeadh cheana.

    • Déan tástáil ar dtús ar na gnéithe API go léir a úsáideann tú i dtáirgeadh i do thionscadal tástála API le EKM.

    • Cuir EKM i bhfeidhm de réir a chéile seachas é a chur ar gach tionscadal API táirgthe ag an am céanna.

Críochphointí ar leibhéal eagraíochta

Cláraigh eochair sheachtrach ar d’eagraíocht

AWS

Iarratas samplach:

  • type: teaghrán - “aws” i gcónaí

  • name: teaghrán - Ainm so-aitheanta ar do chumraíocht

  • role_arn: teaghrán - ARN an róil a ghlacfaidh OpenAI air féin i do néal

  • kms_arn: teaghrán - ARN an Chórais Bainistíochta Eochracha don mháistireochair atá á bainistiú agat

  • external_id: teaghrán - Aitheantas na hEagraíochta nó aitheantas an tionscadail API atá agat

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

Sampla de fhreagra:

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

Iarratas samplach:

  • type: teaghrán - “gcp” i gcónaí,

  • name: teaghrán - Ainm so-aitheanta ar do chumraíocht

  • workload_identity_project_number: teaghrán - Uimhir uimhriúil an tionscadail GCP inar chláraigh tú aitheantas ualaigh oibre OpenAI

  • workload_identity_pool_id: teaghrán - An linn ina bhfuil an soláthraí Workload Identity a chláraigh tú do OpenAI

  • workload_identity_provider_id: teaghrán - An soláthraí Workload Identity a chláraigh tú do OpenAI

  • audience: teaghrán - An spriocghrúpa ba cheart do OpenAI a chur sa chomhartha nuair a ghlacaimid ról orainn féin trí do GCP STS

  • kms_project_id: teaghrán - Ainm an tionscadail GCP ina bhfuil do KMS

  • kms_key_ring_name: teaghrán - Fáinne eochracha an Chórais Bainistíochta Eochracha ina bhfuil an mháistireochair atá á bainistiú agat

  • kms_key_name: teaghrán - Ainm mháistireochair an Chórais Bainistíochta Eochracha

  • kms_key_location: teaghrán - An réigiún ina bhfuil máistireochair do Chórais Bainistíochta Eochracha

Má tá do KMS i dtionscadal GCP eile seachas an ceann inar chláraigh tú Workload Identity OpenAI, cinntigh go bhfuil KMS cumasaithe ar a laghad sa tionscadal ina bhfuil Workload Identity OpenAI trí dhul chuig 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"
}'

Sampla de fhreagra:

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

Iarratas samplach:

  • type: teaghrán - “azure” i gcónaí,

  • name: teaghrán - Ainm so-aitheanta ar do chumraíocht

  • tenant_id: teaghrán - UUID do thionónta Azure

  • vault_uri: teaghrán - URI an taisceáin Azure ina bhfuil an mháistireochair atá á bainistiú agat

  • key_name: teaghrán - Ainm na máistireochrach Azure Key Vault atá á bainistiú agat.

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

Sampla de fhreagra:

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

OCI

Socraigh eochair chumasaithe AES-256 agus tabhair rochtain do OpenAI. Ní mór clib shaorfhoirme openai_organization_id a bheith ar an eochair, agus í socraithe chuig Aitheantas na hEagraíochta atá agat in OpenAI. Le haghaidh na gcéimeanna socraithe, féach: OCI Vault a chumrú le haghaidh Bainistíocht Eochracha Fiontair.

Sampla d'iarratas:

  • type: teaghrán - "oci" i gcónaí

  • purpose: teaghrán - "ekm"; an luach réamhshocraithe má fhágtar ar lár é

  • name: teaghrán - Ainm so-aitheanta ar do chumraíocht

  • region: teaghrán - An réigiún OCI ina bhfuil do chruinneachán agus d'eochair

  • vault_ocid: teaghrán - OCID iomlán do chruinneacháin

  • key_ocid: teaghrán - OCID iomlán d'eochrach AES-256

Ná seol key_version_ocid le haghaidh EKM.

curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys" \
-d '{
"type": "oci",
"purpose": "ekm",
"name": "OCI EKM Config",
"region": "us-ashburn-1",
"vault_ocid": "<VAULT_OCID>",
"key_ocid": "<AES_KEY_OCID>"
}'

Sampla de fhreagra:

{
"id": "extkey_xxxx",
"object": "organization.external_key",
"created_at": 1746175499,
"api_project_ids": [],
"type": "oci",
"purpose": "ekm",
"name": "OCI EKM Config",
"region": "us-ashburn-1",
"vault_ocid": "<VAULT_OCID>",
"key_ocid": "<AES_KEY_OCID>"
}

Tugann an API HTTP 200 ar ais má éiríonn leis an iarratas. Sábháil an id a thugtar ar ais agus úsáid é mar external_key_id agus tionscadal á chruthú agat. Baineann na hoibríochtaí liostaithe, aisghabhála, bailíochtaithe agus scriosta atá ann cheana le cláruithe OCI freisin.

Le haghaidh athshlánú PSP, úsáid clárú ar leith RSA-3072 le purpose: "psp_decryption" agus key_version_ocid beacht. Socraigh psp_decryption_key_id chuig a aitheantas clárúcháin OpenAI. Ní theastaíonn ó OpenAI ach rochtain léitheoireachta ar mheiteashonraí agus ar eochracha poiblí na heochrach RSA sin. Chun na treoracha socraithe iomlána a fháil, féach: Eochracha neamhshiméadracha a shocrú — OCI Vault.

Scrios eochair sheachtrach atá cláraithe le d'eagraíocht

Nóta: Cuirtear bac ar scriosadh fad a bhíonn tionscadal gníomhach nó spás oibre gníomhach ag úsáid an chlárúcháin. I gcás EKM, cuir na tionscadail API ghaolmhara sa chartlann ar dtús; fanann clárú EKM atá bainteach le spás oibre faoi chosaint. I gcás athshlánú PSP, athraigh nó glan psp_decryption_key_id ar gach tionscadal gníomhach a thagraíonn don chlárú sula scriosann tú é. Ní scriostar an eochair néil nuair a scriostar clárú OpenAI.

Sampla d'iarratas

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

Freagra samplach

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

Faigh na heochracha seachtracha atá cláraithe le d'eagraíocht

Gan scagaire de réir cuspóra, beidh cláruithe EKM agus athshlánaithe PSP araon ar an liosta. Úsáid ?purpose=ekm nó ?purpose=psp_decryption chun scagadh de réir cuspóra.

Sampla d'iarratas

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

Freagra samplach

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

Bailíochtaigh eochair sheachtrach

Úsáid bailíochtú chun a sheiceáil an bhfuil rochtain fós ag OpenAI ar d'eochair néil.

  • I gcás EKM, seiceálann OpenAI gur féidir leis criptiú agus díchriptiú a dhéanamh leis an eochair. Chun eolas a fháil ar an gcaoi a n-oibríonn cúlghairm agus taisceadh, féach: treoir maidir le saolré eochracha.

  • I gcás athshlánú PSP, aisghabhann OpenAI eochair phoiblí an leagain chláraithe agus cuireann sé i gcomparáid leis an seatléargas stóráilte í. Ní dheimhníonn bailíochtú rathúil gur féidir le d'aitheantas athshlánaithe díchriptiú a dhéanamh. Má theipeann ar bhailíochtú, ní bhaintear ná ní athchuirtear seatléargas stóráilte na heochrach poiblí.

Nuair a aisghabhtar clárú le GET, tugtar an chumraíocht stóráilte ar ais agus ní dhéantar rochtain ar d'eochair néil a athsheiceáil.

Sampla d'iarratas

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

Sampla de fhreagra

{
"status": "success"
}

Nó, earráid a tháinig chun cinn ón soláthraí néil.

Críochphointí ar leibhéal tionscadail

Cruthaigh tionscadal nua le haitheantas eochrach seachtraí

Tá sé seo mar an gcéanna leis an deireadhphointe Cruthaigh Tionscadal atá ann cheana, ach go bhfuil an paraiméadar external_key_id curtha leis an iarratas agus leis an bhfreagra.

Iarratas samplach

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

Freagra samplach

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

Nuashonraigh tionscadal atá ann cheana le haitheantas eochrach seachtraí

Tá sé seo mar an gcéanna leis an deireadhphointe Nuashonraigh Tionscadal atá ann cheana, ach cuirtear an paraiméadar external_key_id leis an iarratas agus leis an bhfreagra.

Molaimid tionscadail nua API a chruthú do d'ualaí oibre EKM. Tabhair aird ar na dea-chleachtais seo a leanas sula gcuireann tú EKM i bhfeidhm ar na tionscadail atá á n-úsáid agat i dtáirgeadh cheana.

  • Déan tástáil ar dtús ar na gnéithe API go léir a úsáideann tú i dtáirgeadh i do thionscadal tástála API le EKM.

  • Cuir EKM i bhfeidhm de réir a chéile seachas é a chur ar gach tionscadal API táirgthe ag an am céanna.

Sampla d'iarratas

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

Liostaigh na tionscadail go léir i d’eagraíocht

Tá sé seo mar an gcéanna leis an deireadhphointe atá ann cheana, ach go bhfuil external_key_id curtha leis an bhfreagra API.

Iarratas samplach

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

Freagra samplach

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

Ar chuidigh an t-alt seo libh?