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 Realms Admin API

The Realms Admin API from Deutsche Telekom — 28 operation(s) for realms admin.

Deutsche Telekom Realms Admin 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 Realms Admin. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 39 operations across 28 paths, and defines 39 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.

39 operations 28 paths 39 schemas 7 DELETE13 GET11 POST8 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 39

Across 28 paths, the API surfaces 39 operations — 7 DELETE, 13 GET, 11 POST, 8 PUT. Each is listed below with its method, path, parameters, and response codes.

Realms Admin 39
POST
/
Import a realm Imports a realm from a full representation of that realm.
body → 2XX
GET
/{realm}
Get the top-level representation of the realm It will not include nested information like User and Client representations.
1 param → 2XX
PUT
/{realm}
Update the top-level information of the realm Any user, roles or client information in the representation will be ignored.
1 param body → 2XX
DELETE
/{realm}
Delete the realm
1 param → 2XX
GET
/{realm}/admin-events
Get admin events Returns all admin events, or filters events based on URL query parameters listed here
12 params → 2XX
DELETE
/{realm}/admin-events
Delete all admin events
1 param → 2XX
POST
/{realm}/clear-keys-cache
Clear cache of external public keys (Public keys of clients or Identity providers)
1 param → 2XX
POST
/{realm}/clear-realm-cache
Clear realm cache
1 param → 2XX
POST
/{realm}/clear-user-cache
Clear user cache
1 param → 2XX
POST
/{realm}/client-description-converter
Base path for importing clients under this realm.
1 param body → 2XX
GET
/{realm}/client-policies/policies
Get client policies
2 params → 2XX
PUT
/{realm}/client-policies/policies
Update client policies
1 param body → 2XX
GET
/{realm}/client-policies/profiles
Get client profiles
2 params → 2XX
PUT
/{realm}/client-policies/profiles
Update client profiles
1 param body → 2XX
GET
/{realm}/client-session-stats
Get client session stats Returns a JSON map.
1 param → 2XX
GET
/{realm}/credential-registrators
1 param → 2XX
GET
/{realm}/default-default-client-scopes
Get realm default client scopes.
1 param → 2XX
PUT
/{realm}/default-default-client-scopes/{clientScopeId}
2 params → 2XX
DELETE
/{realm}/default-default-client-scopes/{clientScopeId}
2 params → 2XX
GET
/{realm}/default-groups
Get group hierarchy.
1 param → 2XX
PUT
/{realm}/default-groups/{groupId}
2 params → 2XX
DELETE
/{realm}/default-groups/{groupId}
2 params → 2XX
GET
/{realm}/default-optional-client-scopes
Get realm optional client scopes.
1 param → 2XX
PUT
/{realm}/default-optional-client-scopes/{clientScopeId}
2 params → 2XX
DELETE
/{realm}/default-optional-client-scopes/{clientScopeId}
2 params → 2XX
GET
/{realm}/events
Get events Returns all events, or filters them based on URL query parameters listed here
9 params → 2XX
DELETE
/{realm}/events
Delete all events
1 param → 2XX
GET
/{realm}/events/config
Get the events provider configuration Returns JSON object with events provider configuration
1 param → 2XX
PUT
/{realm}/events/config
Update the events provider Change the events provider and/or its configuration
1 param body → 2XX
GET
/{realm}/group-by-path/{_path}
2 params → 2XX
POST
/{realm}/logout-all
Removes all user sessions.
1 param → 2XX
POST
/{realm}/partial-export
Partial export of existing realm into a JSON file.
3 params → 2XX
POST
/{realm}/partialImport
Partial import from a JSON file to an existing realm.
1 param body → 2XX
POST
/{realm}/push-revocation
Push the realm’s revocation policy to any client that has an admin url associated with it.
1 param → 2XX
DELETE
/{realm}/sessions/{session}
Remove a specific user session.
2 params → 2XX
POST
/{realm}/testLDAPConnection
Test LDAP connection
1 param body → 2XX
POST
/{realm}/testSMTPConnection
1 param body → 2XX
GET
/{realm}/users-management-permissions
1 param → 2XX
PUT
/{realm}/users-management-permissions
1 param body → 2XX

Schemas 39

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

CredentialRepresentation
object
9 properties
ClientPolicyExecutorRepresentation
object
2 properties
AdminEventRepresentation
object
8 properties
IdentityProviderMapperRepresentation
object
5 properties
ResourceRepresentation
object
9 properties
IdentityProviderRepresentation
object
12 properties
RolesRepresentation
object
2 properties
UserFederationMapperRepresentation
object
5 properties
UserRepresentation
object
23 properties
ScopeMappingRepresentation
object
4 properties
AuthenticatorConfigRepresentation
object
3 properties
EventRepresentation
object
9 properties
RealmRepresentation
object
113 properties
FederatedIdentityRepresentation
object
3 properties
ResourceServerRepresentation
object
9 properties
GroupRepresentation
object
8 properties
AuthDetailsRepresentation
object
4 properties
PartialImportRepresentation
object
7 properties
ClientPoliciesRepresentation
object
2 properties
RequiredActionProviderRepresentation
object
7 properties
ProtocolMapperRepresentation
object
5 properties
ClientProfileRepresentation
object
3 properties
ScopeRepresentation
object
6 properties
RoleRepresentation-Composites
object
2 properties
ClientRepresentation
object
38 properties
ClientPolicyRepresentation
object
5 properties
UserConsentRepresentation
object
4 properties
ClientScopeRepresentation
object
6 properties
ManagementPermissionReference
object
3 properties
TestLdapConnectionRepresentation
object
8 properties
ClientPolicyConditionRepresentation
object
2 properties
UserFederationProviderRepresentation
object
8 properties
PolicyRepresentation
object
13 properties
AuthenticationFlowRepresentation
object
7 properties
ClientProfilesRepresentation
object
2 properties
MultivaluedHashMap
object
3 properties
AuthenticationExecutionExportRepresentation
object
8 properties
RoleRepresentation
object
8 properties
RealmEventsConfigRepresentation
object
6 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

deutsche-telekom-realms-admin-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 Realms Admin 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.