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

Bainistigh eochracha seachtracha le haghaidh EKM leis an API Bainistíochta

Nuashonraithe: 2 months ago

Achoimre

Rochtain

  • Tá críochphointí EKM ar fáil san API Bainistíochta trí Eochair API Riarthóra. https://platform.openai.com/settings/organization/admin-keys (ná húsáid gnátheochair API). Tá eochracha API riarthóra ar fáil do ú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ú nó a bhailíochtú. Ní bhíonn an dá scóip de dhíth ar eochair aonair ach amháin más gá di oibríochtaí léite agus scríofa araon a dhéanamh.

  • Faoi láthair, ní mór dúinn do d’eagraíocht a chur ar bhratach gné chun na críochphointí seo a úsáid. Beidh a fhios agat go bhfuil an bhratach gné agat má fheiceann tú external_key_id á thabhairt ar ais ón gcríochphointe List Projects atá ann cheana: https://api.openai.com/v1/organization/projects

Ú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 chur ar bun do d’ualaí oibre EKM. Mar sin féin, más mian leat EKM a úsáid ar thionscadal atá ann cheana, is féidir linn thú a chur leis an mbratach gné. Tabhair faoi deara na dea-chleachtais seo a leanas sula gcuireann tú EKM i bhfeidhm ar na tionscadail táirgthe atá agat cheana.

    • Déan tástáil ar dtús i do thionscadal API tástála EKM ar gach gné API a úsáideann tú i dtáirgeadh

    • Cuir i bhfeidhm de réir a chéile é seachas EKM 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: string - i gcónaí “aws”

  • name: string - ainm cairdiúil do do chumraíocht

  • role_arn: string - an Role ARN a ghlacfaidh OpenAI i do néal

  • kms_arn: string - ARN an Chórais Bainistíochta Eochracha don mháistireochair a bhainistíonn tú

  • external_id: string - ID d’eagraíochta nó ID tionscadail 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>
}'

Freagra Samplach

{
  "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: string - i gcónaí "gcp",

  • name: string - ainm cairdiúil do do chumraíocht

  • workload_identity_project_number: string - uimhir 12 dhigit an tionscadail GCP inar chláraigh tú aitheantas ualaigh oibre OpenAI

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

  • workload_identity_provider_id: string - an soláthraí Workload Identity a chláraigh tú do OpenAI

  • audience: string - an lucht féachana ba cheart do OpenAI a chur sa chomhartha nuair a ghlacaimid ról trí do GCP STS

  • kms_project_id: string - ainm an tionscadail GCP ina bhfuil do KMS

  • kms_key_ring_name: string - fáinne eochrach an Chórais Bainistíochta Eochracha ina bhfuil an mháistireochair a bhainistíonn tú

  • kms_key_name: string - ainm mháistireochair an Chórais Bainistíochta Eochracha

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

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

Freagra Samplach

{
  "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: string - i gcónaí "azure",

  • name: string - ainm cairdiúil do do chumraíocht

  • tenant_id: string - UUID do thionónta Azure

  • vault_uri: string - URI an taisclainne Azure ina bhfuil an mháistireochair a bhainistíonn tú

  • key_name: string - ainm mháistireochair Azure Key Vault a bhainistíonn tú.

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

Freagra Samplach

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

Scrios eochair sheachtrach atá cláraithe ar d’eagraíocht

Nóta: Ní féidir leat eochair sheachtrach a scriosadh ach amháin mura bhfuil sí bainteach le haon tionscadal API gníomhach ná spás oibre gníomhach. Má tá sí bainteach le tionscadal API gníomhach, cuir an tionscadal sin sa chartlann ar dtús. Má tá sí bainteach le spás oibre, ní féidir an eochair a scriosadh.

Iarratas Samplach

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 ar d’eagraíocht

Iarratas Samplach

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

Is féidir leat an críochphointe seo a úsáid chun roinnt rudaí a sheiceáil

  • Go bhfanann do chumraíocht néil sheachtrach bailí le OpenAI tar éis duit athruithe a dhéanamh (feicfidh tú freagra ratha)

  • Go bhfuil do chúlghairm eochrach déanta i gceart, á próiseáil ag OpenAI, agus go dtiocfaidh sí i bhfeidhm tar éis do TTLanna taisce 1 uair an chloig dul in éag (feicfidh tú freagra earráide)

Iarratas Samplach

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

Freagra Samplach

{
 "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 ID eochrach seachtraí

Is ionann é seo agus an críochphointe Create Project atá ann cheana, ach an paraiméadar external_key_id a bheith curtha leis san iarratas agus sa fhreagra.

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": "project",
  "id": "proj_xxxxx",
  "title": "Some Project",
  "external_key_id": "extkey_xxxxx",
  "created": 1740012721,
  "organization_id": "org-xxxxx",
  "is_initial": false,
  "geography": null,
  "scale_tier_enabled": false,
  "disable_user_api_keys": false,
  "zdr_type": null,
}

[Srianta] Nuashonraigh tionscadal atá ann cheana le ID eochrach seachtraí

Is ionann é seo agus an críochphointe Update Project atá ann cheana, ach an paraiméadar external_key_id a bheith curtha leis san iarratas agus sa fhreagra.


Molaimid tionscadail API nua a chur ar bun do d’ualaí oibre EKM. Más mian leat EKM a úsáid ar na tionscadail API atá agat cheana, fiafraigh de do stiúrthóir cuntais agus cuirfimid leis an mbratach gné thú. Tabhair faoi deara na dea-chleachtais seo a leanas sula gcuireann tú EKM i bhfeidhm ar na tionscadail táirgthe atá agat cheana.

  • Déan tástáil ar dtús i do thionscadal API tástála EKM ar gach gné API a úsáideann tú i dtáirgeadh

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

Iarratas Samplach

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 uile ar d’eagraíocht

Is ionann é seo agus an críochphointe atá ann cheana, ach external_key_id a bheith curtha leis sa fhreagra 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?