How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Deutsche Telekom Clients API

The Clients API from Deutsche Telekom — 24 operation(s) for clients.

Deutsche Telekom Clients API is one of 50 APIs that Deutsche Telekom publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 32 operations across 24 paths, and defines 23 schemas. It is described by OpenAPI 3.0.1, at version 1.0.0.

Requests are made against a single base URL, https://api.telekom.de/controlplane/v1.

32 operations 24 paths 23 schemas 5 DELETE18 GET5 POST4 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0.0
Server
https://api.telekom.de/controlplane/v1
Contact
Resource Areas
1

Paths & Operations 32

Across 24 paths, the API surfaces 32 operations — 5 DELETE, 18 GET, 5 POST, 4 PUT. Each is listed below with its method, path, parameters, and response codes.

Clients 32
GET
/{realm}/clients
Get clients belonging to the realm Returns a list of clients belonging to the realm
6 params → 2XX
POST
/{realm}/clients
Create a new client Client’s clientid must be unique!
1 param body → 2XX
GET
/{realm}/clients/{id}
Get representation of the client
2 params → 2XX
PUT
/{realm}/clients/{id}
Update the client
2 params body → 2XX
DELETE
/{realm}/clients/{id}
Delete the client
2 params → 2XX
GET
/{realm}/clients/{id}/client-secret
Get the client secret
2 params → 2XX
POST
/{realm}/clients/{id}/client-secret
Generate a new secret for the client
2 params → 2XX
GET
/{realm}/clients/{id}/client-secret/rotated
Get the rotated client secret
2 params → 2XX
DELETE
/{realm}/clients/{id}/client-secret/rotated
Invalidate the rotated secret for the client
2 params → 2XX
GET
/{realm}/clients/{id}/default-client-scopes
Get default client scopes.
2 params → 2XX
PUT
/{realm}/clients/{id}/default-client-scopes/{clientScopeId}
3 params → 2XX
DELETE
/{realm}/clients/{id}/default-client-scopes/{clientScopeId}
3 params → 2XX
GET
/{realm}/clients/{id}/evaluate-scopes/generate-example-access-token
Create JSON with payload of example access token
4 params → 2XX
GET
/{realm}/clients/{id}/evaluate-scopes/protocol-mappers
Return list of all protocol mappers, which will be used when generating tokens issued for particular client.
3 params → 2XX
GET
/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/granted
Get effective scope mapping of all roles of particular role container, which this client is defacto allowed to have in the accessToken issued for him.
4 params → 2XX
GET
/{realm}/clients/{id}/evaluate-scopes/scope-mappings/{roleContainerId}/not-granted
Get roles, which this client doesn’t have scope for and can’t have them in the accessToken issued for him.
4 params → 2XX
GET
/{realm}/clients/{id}/installation/providers/{providerId}
3 params → 2XX
GET
/{realm}/clients/{id}/management/permissions
Return object stating whether client Authorization permissions have been initialized or not and a reference
2 params → 2XX
PUT
/{realm}/clients/{id}/management/permissions
Return object stating whether client Authorization permissions have been initialized or not and a reference
2 params body → 2XX
POST
/{realm}/clients/{id}/nodes
Register a cluster node with the client Manually register cluster node to this client - usually it’s not needed to call this directly as adapter should handle by sending registration request to Keycl…
2 params body → 2XX
DELETE
/{realm}/clients/{id}/nodes/{node}
Unregister a cluster node from the client
3 params → 2XX
GET
/{realm}/clients/{id}/offline-session-count
Get application offline session count Returns a number of offline user sessions associated with this client { "count": number }
2 params → 2XX
GET
/{realm}/clients/{id}/offline-sessions
Get offline sessions for client Returns a list of offline user sessions associated with this client
4 params → 2XX
GET
/{realm}/clients/{id}/optional-client-scopes
Get optional client scopes.
2 params → 2XX
PUT
/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
3 params → 2XX
DELETE
/{realm}/clients/{id}/optional-client-scopes/{clientScopeId}
3 params → 2XX
POST
/{realm}/clients/{id}/push-revocation
Push the client’s revocation policy to its admin URL If the client has an admin URL, push revocation policy to it.
2 params → 2XX
POST
/{realm}/clients/{id}/registration-access-token
Generate a new registration access token for the client
2 params → 2XX
GET
/{realm}/clients/{id}/service-account-user
Get a user dedicated to the service account
2 params → 2XX
GET
/{realm}/clients/{id}/session-count
Get application session count Returns a number of user sessions associated with this client { "count": number }
2 params → 2XX
GET
/{realm}/clients/{id}/test-nodes-available
Test if registered cluster nodes are available Tests availability by sending 'ping' request to all cluster nodes.
2 params → 2XX
GET
/{realm}/clients/{id}/user-sessions
Get user sessions for client Returns a list of user sessions associated with this client
4 params → 2XX

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are AccessToken (43 properties), ClientRepresentation (38 properties), UserRepresentation (23 properties), PolicyRepresentation (13 properties). Each schema is shown below with its type and property counts.

AccessToken-CertConf
object
1 property
CredentialRepresentation
object
9 properties
AccessToken
object
43 properties
ResourceRepresentation
object
9 properties
AccessToken-Authorization
object
1 property
AddressClaimSet
object
6 properties
UserRepresentation
object
23 properties
FederatedIdentityRepresentation
object
3 properties
UserSessionRepresentation
object
7 properties
GlobalRequestResult
object
2 properties
ClientScopeEvaluateResource-ProtocolMapperEvaluationRepresentation
object
6 properties
Permission
object
4 properties
ProtocolMapperRepresentation
object
5 properties
ScopeRepresentation
object
6 properties
RoleRepresentation-Composites
object
2 properties
ClientRepresentation
object
38 properties
UserConsentRepresentation
object
4 properties
ClientScopeRepresentation
object
6 properties
ManagementPermissionReference
object
3 properties
PolicyRepresentation
object
13 properties
ResourceServerRepresentation
object
9 properties
RoleRepresentation
object
8 properties
AccessToken-Access
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deutsche-telekom-clients-api-openapi.yml Raw ↑

Other APIs Deutsche Telekom publishes across the network.

Deutsche Telekom SMS API
Deutsche Telekom Rich Communication Services API
Deutsche Telekom Conversational Connect API
Deutsche Telekom Voice API
Deutsche Telekom Video API
Deutsche Telekom Reports API
Deutsche Telekom AI Studio
Deutsche Telekom Number Verification API
Deutsche Telekom Verify API
Deutsche Telekom 5G Slices for App Developers
Open Telekom Cloud
Open Telekom Integration Platform
Where this information came from

This is an independent, third-party profile of Deutsche Telekom Clients API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.