Get Credential Organization
Deprecated
This operation is deprecated. It still works. Use the successor operation of the Consumer Organizations API instead.
Every response of this operation carries a Deprecation: @1792368000 header and a Link header whose rel is successor-version:
Link: </apiops/projects/{projectName}/consumer-organizations>; rel="successor-version"
Endpoint
GET /apiops/projects/{projectName}/credential-organizations/{code}
Authentication
Requires a Personal API Access Token.
Header
Authorization: Bearer YOUR_TOKEN
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer {token} | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| projectName | string | Yes | Project name |
| code | string | Yes | Organization 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
}
]
}
The response does not carry limit plans. The limit plans applied to an organization are listed on its Limits tab and, by name, through the Limit Assignments Management API.
Error Responses
| Status | Condition |
|---|---|
| 401 | Invalid or missing token |
| 404 | Organization with the given code does not exist in the project |
| 500 | Unexpected 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: truereturnvalue: nullon GET. Re-supply the value on PUT to change it. parentOrganizationCodeis resolved at read time from the stored parent reference.
Permissions
User must have IDENTITY + VIEW permission in the project (or any permission if the category does not exist).