சுருக்கம்
அணுகல்
நிர்வாகி API விசை மூலம் மேலாண்மை API-இல் EKM எண்ட்பாயிண்ட்களை அணுகலாம். https://platform.openai.com/settings/organization/admin-keys (வழக்கமான API விசையைப் பயன்படுத்த வேண்டாம்). நிர்வாகி API விசைகள் நிறுவன உரிமையாளர்களுக்குக் கிடைக்கும்.
வெளிப்புற விசைகளை உருவாக்க அல்லது நீக்க
api.external_keys.writeஎன்பதையும், அவற்றைப் பட்டியலிட, பெற அல்லது சரிபார்க்கapi.external_keys.readஎன்பதையும் பயன்படுத்தவும். ஒரே விசை வாசித்தல், எழுதுதல் ஆகிய இரு செயல்பாடுகளையும் செய்ய வேண்டியிருந்தால் மட்டுமே அதற்கு இரு அனுமதி வரம்புகளும் தேவை.
பயன்பாடு
https://api.openai.com/v1/organization/external_keys என்ற புதிய எண்ட்பாயிண்ட் மூலம் உங்கள் EKM உள்ளமைவு நிறுவன அளவில் பதிவுசெய்யப்படுகிறது.
உங்கள் EKM உள்ளமைவைப் பதிவுசெய்யும்போது, extkey_xxxx என்ற வடிவத்தில் external_key_id திருப்பி அனுப்பப்படும்.
ஏற்கெனவே உள்ள திட்டத்தை உருவாக்கும் https://api.openai.com/v1/organization/projects எண்ட்பாயிண்டின் கோரிக்கை உடலில் external_key_id-ஐ அனுப்புவதன் மூலம் EKM உள்ளமைவுகள் திட்ட அளவில் செயல்படுத்தப்படுகின்றன.
கட்டுப்பாடுகள்
முதலில் மேலாண்மை API மூலம் புதிய திட்டத்தில் EKM-ஐச் சோதிக்க வேண்டும்.
உங்கள் EKM பணிச்சுமைகளுக்குப் புதிய திட்டங்களை உருவாக்குமாறு பரிந்துரைக்கிறோம். ஏற்கெனவே பயன்பாட்டில் உள்ள திட்டங்களில் EKM-ஐ அறிமுகப்படுத்தும் முன், பின்வரும் சிறந்த நடைமுறைகளைக் கவனத்தில் கொள்ளவும்.
நேரடிப் பயன்பாட்டில் நீங்கள் பயன்படுத்தும் அனைத்து API அம்சங்களையும் முதலில் உங்கள் சோதனை EKM API திட்டத்தில் சோதிக்கவும்.
பயன்பாட்டில் உள்ள அனைத்து API திட்டங்களிலும் ஒரே நேரத்தில் EKM-ஐச் செயல்படுத்தாமல், படிப்படியாகச் செயல்படுத்தவும்.
நிறுவன-நிலை endpoints
உங்கள் நிறுவனத்தில் வெளிப்புற key-ஐ பதிவுசெய்யவும்
AWS
மாதிரிக் கோரிக்கை:
type: சரம் - எப்போதும் “aws”
name: சரம் - உங்கள் உள்ளமைவை எளிதில் அடையாளம் காண உதவும் பெயர்
role_arn: சரம் - உங்கள் மேகச் சூழலில் OpenAI ஏற்கவுள்ள பாத்திரத்தின் ARN
kms_arn: சரம் - நீங்கள் நிர்வகிக்கும் முதன்மை விசைக்கான விசை மேலாண்மை அமைப்பின் ARN
external_id: சரம் - உங்கள் நிறுவன 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: சரம் - எப்போதும் “gcp”,
name: சரம் - உங்கள் உள்ளமைவை எளிதில் அடையாளம் காண உதவும் பெயர்
workload_identity_project_number: சரம் - OpenAI-இன் பணிச்சுமை அடையாளத்தை நீங்கள் பதிவுசெய்த GCP திட்டத்தின் எண்
workload_identity_pool_id: சரம் - OpenAI-க்காக நீங்கள் பதிவுசெய்த பணிச்சுமை அடையாள வழங்குநர் இடம்பெற்றுள்ள தொகுப்பு
workload_identity_provider_id: சரம் - OpenAI-க்காக நீங்கள் பதிவுசெய்த பணிச்சுமை அடையாள வழங்குநர்
audience: சரம் - உங்கள் GCP STS மூலம் OpenAI ஒரு பாத்திரத்தை ஏற்கும்போது டோக்கனில் அனுப்ப வேண்டிய இலக்குப் பெறுநர்
kms_project_id: சரம் - உங்கள் KMS அமைந்துள்ள GCP திட்டத்தின் பெயர்
kms_key_ring_name: சரம் - நீங்கள் நிர்வகிக்கும் முதன்மை விசையைக் கொண்டுள்ள விசை மேலாண்மை அமைப்பின் விசைத்தொகுப்பு
kms_key_name: சரம் - விசை மேலாண்மை அமைப்பின் முதன்மை விசையின் பெயர்
kms_key_location: சரம் - உங்கள் விசை மேலாண்மை அமைப்பின் முதன்மை விசை அமைந்துள்ள பிராந்தியம்
OpenAI-இன் பணிச்சுமை அடையாளத்தை நீங்கள் பதிவுசெய்த GCP திட்டத்திலிருந்து வேறொரு GCP திட்டத்தில் உங்கள் KMS இருந்தால், https://console.developers.google.com/apis/api/cloudkms.googleapis.com/overview பக்கத்திற்குச் சென்று, OpenAI-இன் பணிச்சுமை அடையாளம் உள்ள திட்டத்தில் குறைந்தபட்சம் 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: சரம் - எப்போதும் “azure”,
name: சரம் - உங்கள் உள்ளமைவை எளிதில் அடையாளம் காண உதவும் பெயர்
tenant_id: சரம் - உங்கள் Azure குத்தகைதாரரின் UUID
vault_uri: சரம் - நீங்கள் நிர்வகிக்கும் முதன்மை விசையைக் கொண்டுள்ள Azure பெட்டகத்தின் URI
key_name: சரம் - நீங்கள் நிர்வகிக்கும் 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"
}OCI
செயல்படுத்தப்பட்ட AES-256 விசையை அமைத்து, OpenAI-க்கு அணுகலை வழங்கவும். விசையில் கட்டற்ற வடிவிலான openai_organization_id குறிச்சொல் இருக்க வேண்டும்; அதன் மதிப்பாக உங்கள் OpenAI நிறுவன ID அமைக்கப்பட்டிருக்க வேண்டும். அமைப்பதற்கான படிகளுக்கு, நிறுவன விசை மேலாண்மைக்காக OCI Vault-ஐ உள்ளமைத்தல் என்பதைப் பார்க்கவும்.
மாதிரிக் கோரிக்கை:
type: சரம் - எப்போதும் "oci"
purpose: சரம் - "ekm"; குறிப்பிடப்படாவிட்டால் இதுவே இயல்புநிலை
name: சரம் - உங்கள் உள்ளமைவை எளிதில் அடையாளம் காண உதவும் பெயர்
region: சரம் - உங்கள் பாதுகாப்பகமும் விசையும் உள்ள OCI மண்டலம்
vault_ocid: சரம் - உங்கள் பாதுகாப்பகத்தின் முழு OCID
key_ocid: சரம் - உங்கள் AES-256 விசையின் முழு OCID
EKM-க்கு key_version_ocid-ஐ அனுப்ப வேண்டாம்.
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>"
}'மாதிரிப் பதில்:
{
"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>"
}செயல்பாடு வெற்றியடைந்தால் API, HTTP 200-ஐத் திருப்பியளிக்கும். திருப்பியளிக்கப்பட்ட id-ஐச் சேமித்து, திட்டத்தை உருவாக்கும்போது அதை external_key_id ஆகப் பயன்படுத்தவும். ஏற்கெனவே உள்ள பட்டியலிடுதல், பெறுதல், சரிபார்த்தல் மற்றும் நீக்குதல் செயல்பாடுகள் OCI பதிவுகளுக்கும் பொருந்தும்.
PSP மீட்புக்காக, purpose: "psp_decryption" மற்றும் துல்லியமான key_version_ocid ஆகியவற்றைக் கொண்ட தனி RSA-3072 பதிவைப் பயன்படுத்தவும். psp_decryption_key_id-இன் மதிப்பாக அதன் OpenAI பதிவு ID-ஐ அமைக்கவும். அந்த RSA விசையின் மீத்தரவையும் பொது விசைகளையும் வாசிப்பதற்கான அணுகல் மட்டுமே OpenAI-க்குத் தேவை. முழுமையான அமைப்பு வழிமுறைகளுக்கு, சமச்சீரற்ற விசைகளை அமைத்தல் — OCI Vault என்பதைப் பார்க்கவும்.
உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்டுள்ள வெளிப்புற விசையை நீக்குதல்
குறிப்பு: செயலில் உள்ள திட்டம் அல்லது வர்க்ஸ்பேஸ் இந்தப் பதிவைப் பயன்படுத்தும்போது அதை நீக்க முடியாது. EKM-ஐப் பொறுத்தவரை, தொடர்புடைய API திட்டங்களை முதலில் காப்பகப்படுத்தவும்; வர்க்ஸ்பேஸுடன் தொடர்புடைய EKM பதிவை நீக்குவதற்கான தடை தொடரும். PSP மீட்புப் பதிவை நீக்கும் முன், அதைக் குறிப்பிடும் செயலில் உள்ள ஒவ்வொரு திட்டத்திலும் psp_decryption_key_id-இன் மதிப்பை மாற்றவும் அல்லது அகற்றவும். OpenAI பதிவை நீக்குவதால் மேகக்கணினி விசை நீக்கப்படாது.
மாதிரிக் கோரிக்கை
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>"
}உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்டுள்ள வெளிப்புற விசைகளைப் பெறுதல்
நோக்கத்தின் அடிப்படையில் வடிகட்டாவிட்டால், பட்டியலில் EKM மற்றும் PSP மீட்புப் பதிவுகள் இரண்டும் இடம்பெறும். பயன்படுத்த வேண்டியது: ?purpose=ekm அல்லது ?purpose=psp_decryption (நோக்கத்தின் அடிப்படையில் வடிகட்ட).
மாதிரிக் கோரிக்கை
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"
}வெளிப்புற விசையைச் சரிபார்த்தல்
உங்கள் மேகக்கணினி விசையை OpenAI இன்னும் அணுக முடிகிறதா என்பதை அறிய சரிபார்ப்பைப் பயன்படுத்தவும்.
EKM-ஐப் பொறுத்தவரை, அந்த விசையைப் பயன்படுத்தி குறியாக்கவும் மறைவிலக்கவும் முடிகிறதா என்பதை OpenAI சரிபார்க்கிறது. அணுகல் ரத்து மற்றும் தற்காலிகச் சேமிப்பின் செயல்பாடு குறித்து அறிய, விசையின் வாழ்க்கைச் சுழற்சி வழிகாட்டுதலைப் பார்க்கவும்.
PSP மீட்புக்காக, பதிவுசெய்யப்பட்ட பதிப்பின் பொது விசையை OpenAI பெற்று, சேமிக்கப்பட்டுள்ள அந்நேர நகலுடன் ஒப்பிடுகிறது. சரிபார்ப்பு வெற்றியடைந்தாலும், உங்கள் மீட்பு அடையாளத்தால் மறைவிலக்க முடியும் என்பது உறுதியாகாது. சரிபார்ப்பு தோல்வியடைந்தாலும், சேமிக்கப்பட்டுள்ள பொது விசையின் அந்நேர நகல் அகற்றப்படவோ மாற்றப்படவோ மாட்டாது.
GET மூலம் ஒரு பதிவைப் பெறும்போது, சேமிக்கப்பட்ட உள்ளமைவு திருப்பியளிக்கப்படும்; உங்கள் மேகக்கணினி விசைக்கான அணுகல் மீண்டும் சரிபார்க்கப்படாது.
மாதிரிக் கோரிக்கை
curl -X POST -H "Authorization: Bearer $TOKEN" \
"https://api.openai.com/v1/organization/external_keys/extkey_xxx/validate"மாதிரிப் பதில்
{
"status": "success"
}அல்லது, cloud provider-இலிருந்து காட்டப்பட்ட பிழை.
திட்ட-நிலை 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 திட்டங்களை உருவாக்குமாறு பரிந்துரைக்கிறோம். ஏற்கெனவே பயன்பாட்டில் உள்ள திட்டங்களில் 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
}