APIKey pattern change

Products

• CA API Gateway

Issue/Introduction

Require APIKey pattern for new application in portal in UUID format. 

Aspect	DI Token UUID	Layer7 String
Value	123e4567-e89b-12d3-a456-426614174000	l7930decc75b042fcd897341bbaac58d08
Length	36 characters (32 hex + 4 hyphens)	33 characters
Allowed Characters	Hex digits only (0–9, a–f) + hyphens	Contains l (not valid in hex)
Format	8-4-4-4-12 (5 groups separated by hyphens)	No groups, no hyphens
Compliance	RFC 4122 compliant	❌ Not compliant

 

 

 

Environment

Gateway 11.1.1 OTK 4.6.3 Portal 5.2

Resolution

In the current version of portal this is not possible using portal UI, it would require a code change.

Workaround:

The APIKey added as UUID format using PAPI 

Steps;

Retrieve access token for tenant

Retrieve the application UUID reuireeming a new APIkey

 POST  https://apim-ssg.<tenant-portal_domain?:9443/<my-tenant>/api-management/1.0/applications/8e9d4f2f-52c4-41db-8ca8-6603afff75a4/api-keys

Body:

{

  "name": "Another New Key",

  "apiKey": "123e4567-e89b-12d3-a456-426614174000",

  "keySecret": "<key secret>",

  "applicationUuid": "8e9d4f2f-52c4-41db-8ca8-6603afff75a4",

  "oauthCallbackUrl": null,

  "oauthScope": "OOB",

  "oauthType": "PUBLIC",

  "keySecretHashed": false,

  "defaultKey": false

}

Response 

{

  "applicationUuid": "8e9d4f2f-52c4-41db-8ca8-6603afff75a4",

  "name": "Another New Key",

  "apiKey": "123e4567-e89b-12d3-a456-426614174000",

  "keySecret": "asasdaasdsadasdas",

  "defaultKey": false,

  "oauthScope": "OOB",

  "oauthType": "PUBLIC",

  "status": "ENABLED",

  "keySecretHashed": false,

  "authMethod": "SECRET",

  "authProviderUuid": "77a39e3c-4ea6-11ef-9a16-0242ac1e0003",

  "createTs": 1760119592364,

  "modifyTs": 1760119592364,

  "secretModifyTs": 1760119592361,

  "secretModifyDate": "2025-10-10T18:06:32+0000",

  "links": []

}