Ana içeriğe geç

Get Credential Organization

Endpoint​

GET /apiops/projects/{projectName}/credential-organizations/{code}

Authentication​

Requires a Personal API Access Token.

Authorization: Bearer YOUR_TOKEN

Request​

Headers​

HeaderValueRequired
AuthorizationBearer {token}Yes

Path Parameters​

ParameterTypeRequiredDescription
projectNamestringYesProject name
codestringYesOrganization code (stable public identifier)

Response​

Success Response (200 OK)​

Returns a CredentialOrganizationDTO.

{
  "code": "team-alpha",
  "nameDefault": "Team Alpha",
  "nameSecondary": "Alpha Ekibi",
  "parentOrganizationCode": "root-org",
  "metadata": [
    {
      "key": "costCenter",
      "value": "CC-1001",
      "secret": false,
      "includeInJwt": true,
      "includeInTokenResponse": false,
      "jwtClaimName": null
    },
    {
      "key": "apiSecret",
      "value": null,
      "secret": true,
      "includeInJwt": false,
      "includeInTokenResponse": false,
      "jwtClaimName": null
    }
  ],
  "defaultLimitPlans": [
    { "family": "REQUEST_RATE", "planKey": "standard-rate", "scope": "PROJECT" },
    { "family": "AI_TOKEN_BUDGET", "planKey": "gold-ai", "scope": "PLATFORM" }
  ]
}

defaultLimitPlans lists the organization's default limit plan per family (only families that have one). Consumers created under the organization from then on receive an assignment pointing at that plan; existing consumers are not affected. Plans are referenced by planKey, never by id. Each entry also carries scope (PROJECT or PLATFORM) — the catalog the planKey was resolved from, since the same key can exist in both; it is always filled in for a family that has a plan.

Error Responses​

StatusCondition
401Invalid or missing token
404Organization with the given code does not exist in the project
500Unexpected server error

cURL Example​

curl -X GET \
  "https://demo.apinizer.com/apiops/projects/MyProject/credential-organizations/team-alpha" \
  -H "Authorization: Bearer YOUR_TOKEN"

Notes and Warnings​

  • Secret metadata values are write-only. Entries with secret: true return value: null on GET. Re-supply the value on PUT to change it.
  • parentOrganizationCode is resolved at read time from the stored parent reference.
  • defaultLimitPlans reflects only enabled defaults. A family with no default plan is simply absent from the list.

Permissions​

User must have IDENTITY + VIEW permission in the project (or any permission if the category does not exist).

En son tarihinde güncellendi