மேலாண்மை API மூலம் EKM-க்கான வெளிப்புற விசைகளை நிர்வகிப்பது எப்படி என அறிக.

சுருக்கம்

அணுகல்

நிர்வாக API விசையைப் பயன்படுத்தி மேலாண்மை API வழியாக EKM எண்ட்பாயிண்ட்களை அணுகலாம். https://platform.openai.com/settings/organization/admin-keys (வழக்கமான API விசையைப் பயன்படுத்த வேண்டாம்). நிறுவன உரிமையாளர்களுக்கு நிர்வாக API விசைகள் கிடைக்கும்.
வெளிப்புற விசைகளை உருவாக்க அல்லது நீக்க api.external_keys.write என்பதையும், அவற்றைப் பட்டியலிட அல்லது சரிபார்க்க api.external_keys.read என்பதையும் பயன்படுத்தவும். ஒரே விசை படித்தல், எழுதுதல் ஆகிய இரு செயல்பாடுகளையும் செய்ய வேண்டியிருந்தால் மட்டுமே அதற்கு இரு அனுமதி வரம்புகளும் தேவை.
தற்போது, இந்த எண்ட்பாயிண்ட்களை உங்கள் நிறுவனம் அணுகுவதற்கான அம்சக் கொடியை நாங்கள் இயக்க வேண்டும். ஏற்கெனவே உள்ள திட்டங்களைப் பட்டியலிடும் எண்ட்பாயிண்டின் பதிலில் external_key_id இருந்தால், உங்களுக்கான அம்சக் கொடி இயக்கப்பட்டுள்ளது என்பதை அறியலாம்: https://api.openai.com/v1/organization/projects.

பயன்பாடு

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 வேண்டுமெனில், உங்களுக்கான அம்சக் கொடியை நாங்கள் இயக்கலாம். ஏற்கெனவே நேரடிப் பயன்பாட்டில் உள்ள உங்கள் திட்டங்களில் 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"
}

உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்ட வெளிப்புற விசையை நீக்குதல்

குறிப்பு: செயலிலுள்ள எந்த API திட்டத்துடனும் அல்லது வர்க்ஸ்பேஸுடனும் இணைக்கப்படாத வெளிப்புற விசையை மட்டுமே நீக்க முடியும். அது செயலிலுள்ள API திட்டத்துடன் இணைக்கப்பட்டிருந்தால், முதலில் அந்தத் திட்டத்தைக் காப்பகப்படுத்தவும். அது ஒரு வர்க்ஸ்பேஸுடன் இணைக்கப்பட்டிருந்தால், அந்த விசையை நீக்க முடியாது.

மாதிரிக் கோரிக்கை

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

உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்ட வெளிப்புற விசைகளைப் பெறுதல்

மாதிரிக் கோரிக்கை

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 உடன் தொடர்ந்து செல்லுபடியாகிறது என்பதைச் சரிபார்க்கலாம் (வெற்றியைக் குறிக்கும் பதில் கிடைக்கும்).
உங்கள் விசை ரத்துசெய்தல் சரியாக மேற்கொள்ளப்பட்டுள்ளது, அதை OpenAI செயலாக்குகிறது, மேலும் 1 மணிநேரத் தற்காலிகச் சேமிப்பு ஆயுட்காலங்கள் முடிந்ததும் அது நடைமுறைக்கு வரும் என்பதைச் சரிபார்க்கலாம் (பிழையைக் குறிக்கும் பதில் கிடைக்கும்).

மாதிரிக் கோரிக்கை

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 திட்டங்களை உருவாக்குமாறு பரிந்துரைக்கிறோம். ஏற்கெனவே உள்ள உங்கள் அனைத்து API திட்டங்களிலும் EKM வேண்டுமெனில், உங்கள் கணக்கு இயக்குநரிடம் கோருங்கள்; உங்களுக்கான அம்சக் கொடியை நாங்கள் இயக்குவோம். ஏற்கெனவே நேரடிப் பயன்பாட்டில் உள்ள உங்கள் திட்டங்களில் 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
}

Management API-இல் EKM (External Keys)

சுருக்கம்

அணுகல்

பயன்பாடு

கட்டுப்பாடுகள்

நிறுவன-நிலை endpoints

உங்கள் நிறுவனத்தில் வெளிப்புற key-ஐ பதிவுசெய்யவும்

AWS

GCP

Azure

உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்ட வெளிப்புற விசையை நீக்குதல்

மாதிரிக் கோரிக்கை

மாதிரிப் பதில்

உங்கள் நிறுவனத்தில் பதிவுசெய்யப்பட்ட வெளிப்புற விசைகளைப் பெறுதல்

மாதிரிக் கோரிக்கை

மாதிரிப் பதில்

வெளிப்புற விசையைச் சரிபார்த்தல்

மாதிரிக் கோரிக்கை

மாதிரிப் பதில்

திட்ட-நிலை endpoints

வெளிப்புற விசை ID உடன் புதிய திட்டத்தை உருவாக்குதல்

மாதிரிக் கோரிக்கை

மாதிரிப் பதில்

[கட்டுப்படுத்தப்பட்டது] ஏற்கெனவே உள்ள திட்டத்தில் வெளிப்புற விசை ID-ஐச் சேர்த்துப் புதுப்பித்தல்

மாதிரிக் கோரிக்கை

உங்கள் நிறுவனத்தில் உள்ள அனைத்துத் திட்டங்களையும் பட்டியலிடுதல்

மாதிரிக் கோரிக்கை

மாதிரிப் பதில்

இந்தக் கட்டுரை உங்களுக்கு உதவியாக இருந்ததா?