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

Achoimre

Rochtain

Is féidir teacht ar dheireadhphointí EKM san API Bainistíochta le hEochair 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ú nó a bhailíochtú. Ní theastaíonn an dá scóip ó eochair amháin ach amháin má chaithfidh sí oibríochtaí léitheoireachta agus scríbhneoireachta araon a dhéanamh.
Faoi láthair, ní mór dúinn bratach ghné a chumasú do d’eagraíocht chun rochtain a thabhairt ar na deireadhphointí seo. Beidh a fhios agat go bhfuil an bhratach ghné cumasaithe má fheiceann tú external_key_id sa fhreagra ón deireadhphointe Liostaigh Tionscadail atá ann cheana: https://api.openai.com/v1/organization/projects.

Úsáid

Déantar do chumraíocht EKM a chlárú ar leibhéal na heagraíochta trí dheireadhphointe nua https://api.openai.com/v1/organization/external_keys.
Nuair a chláraíonn tú do chumraíocht EKM, seoltar external_key_id ar ais san fhoirm extkey_xxxx.
Déantar cumraíochtaí EKM a ghníomhachtú ar leibhéal an tionscadail trí external_key_id a chur i gcorp an iarratais chuig an deireadhphointe Cruthaigh Tionscadal atá ann cheana: https://api.openai.com/v1/organization/projects.

Srianta

Ní mór duit EKM a thástáil ar thionscadal nua tríd an API Bainistíochta ar dtús.
Molaimid tionscadail nua a chur ar bun le haghaidh d’ualaí oibre EKM. Más mian leat EKM a úsáid ar thionscadal atá ann cheana, áfach, is féidir linn an bhratach ghné a chumasú duit. Tabhair aird ar na dea-chleachtais seo a leanas sula gcuirfidh tú EKM i bhfeidhm ar do thionscadail táirgthe atá ann cheana.
- Tástáil na gnéithe API go léir a úsáideann tú i dtáirgeadh i do thionscadal tástála API EKM ar dtús.
- Cuir EKM i bhfeidhm de réir a chéile seachas é a chumasú ar na tionscadail API táirgthe go léir 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>"
}'

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

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: 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.
- Caithfidh sí a bheith san fhoirm <org-xxx>--<any_name>
- áit arb é org-xxx Aitheantas na hEagraíochta OpenAI atá agat, agus atá le fáil ag 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"
}'

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

Nóta: Ní féidir eochair sheachtrach a scriosadh ach amháin mura bhfuil sí bainteach le haon tionscadal API gníomhach ná le haon spás oibre. 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 le 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 deireadhphointe seo a úsáid chun roinnt rudaí a sheiceáil:

Go bhfuil do chumraíocht néil sheachtraigh fós bailí le OpenAI tar éis duit athruithe a dhéanamh (feicfidh tú freagra a léiríonn gur éirigh leis an iarratas).
Go ndearnadh d’eochair a chúlghairm i gceart, go bhfuil OpenAI ag próiseáil na cúlghairme, agus go dtiocfaidh sí i bhfeidhm nuair a bheidh TTLanna aonuaire an taisce imithe 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 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"
}

[Srianta] 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 go bhfuil an paraiméadar external_key_id curtha leis an iarratas agus leis an bhfreagra.

Molaimid tionscadail API nua a chur ar bun le haghaidh d’ualaí oibre EKM. Más mian leat EKM a úsáid ar na tionscadail API go léir atá agat cheana, iarr ar do stiúrthóir cuntais é agus cumasóimid an bhratach ghné duit. Tabhair aird ar na dea-chleachtais seo a leanas sula gcuirfidh tú EKM i bhfeidhm ar do thionscadail táirgthe atá ann cheana.

Tástáil na gnéithe API go léir a úsáideann tú i dtáirgeadh i do thionscadal tástála API EKM ar dtús.
Cuir EKM i bhfeidhm de réir a chéile seachas é a chumasú ar na tionscadail API táirgthe go léir 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 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
}

EKM (Eochracha Seachtracha) san API Bainistíochta

Achoimre

Rochtain

Úsáid

Srianta

Críochphointí ar leibhéal eagraíochta

Cláraigh eochair sheachtrach ar d’eagraíocht

AWS

GCP

Azure

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

Iarratas samplach

Freagra samplach

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

Iarratas samplach

Freagra samplach

Bailíochtaigh eochair sheachtrach

Iarratas samplach

Freagra samplach

Críochphointí ar leibhéal tionscadail

Cruthaigh tionscadal nua le haitheantas eochrach seachtraí

Iarratas samplach

Freagra samplach

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

Iarratas samplach

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

Iarratas samplach

Freagra samplach

Ar chuidigh an t-alt seo libh?