{
  "opencollection": "1.0.0",
  "info": {
    "name": "Controlplane Api ApiChangelog Users API",
    "version": "1.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Users",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get users   Returns a list of users, filtered according to query parameters",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "briefRepresentation",
                "value": "",
                "type": "query"
              },
              {
                "name": "email",
                "value": "",
                "type": "query"
              },
              {
                "name": "first",
                "value": "",
                "type": "query"
              },
              {
                "name": "firstName",
                "value": "",
                "type": "query"
              },
              {
                "name": "lastName",
                "value": "",
                "type": "query"
              },
              {
                "name": "max",
                "value": "",
                "type": "query",
                "description": "Maximum results size (defaults to 100)"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "A String contained in username, first or last name, or email"
              },
              {
                "name": "username",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "Get users   Returns a list of users, filtered according to query parameters"
        },
        {
          "info": {
            "name": "Create a new user   Username must be unique.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Create a new user   Username must be unique."
        },
        {
          "info": {
            "name": "Returns the number of users that match the given criteria.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/count",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "email",
                "value": "",
                "type": "query",
                "description": "email filter"
              },
              {
                "name": "firstName",
                "value": "",
                "type": "query",
                "description": "first name filter"
              },
              {
                "name": "lastName",
                "value": "",
                "type": "query",
                "description": "last name filter"
              },
              {
                "name": "search",
                "value": "",
                "type": "query",
                "description": "arbitrary search string for all the fields below"
              },
              {
                "name": "username",
                "value": "",
                "type": "query",
                "description": "username filter"
              }
            ]
          },
          "docs": "Returns the number of users that match the given criteria."
        },
        {
          "info": {
            "name": "Get representation of the user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Get representation of the user"
        },
        {
          "info": {
            "name": "Update the user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Update the user"
        },
        {
          "info": {
            "name": "Delete the user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Delete the user"
        },
        {
          "info": {
            "name": "Return credential types, which are provided by the user storage where user is stored.",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/configured-user-storage-credential-types",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Return credential types, which are provided by the user storage where user is stored."
        },
        {
          "info": {
            "name": "Get consents granted by the user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/consents",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Get consents granted by the user"
        },
        {
          "info": {
            "name": "Revoke consent and offline tokens for particular client from user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/consents/:client",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "client",
                "value": "",
                "type": "path",
                "description": "Client id"
              }
            ]
          },
          "docs": "Revoke consent and offline tokens for particular client from user"
        },
        {
          "info": {
            "name": "GET /{realm}/users/{id}/credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/credentials",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          }
        },
        {
          "info": {
            "name": "Remove a credential for a user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/credentials/:credentialId",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "credentialId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Remove a credential for a user"
        },
        {
          "info": {
            "name": "Move a credential to a position behind another credential",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/credentials/:credentialId/moveAfter/:newPreviousCredentialId",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "The credential to move"
              },
              {
                "name": "newPreviousCredentialId",
                "value": "",
                "type": "path",
                "description": "The credential that will be the previous element in the list. If set to null, the moved credential will be the first element in the list."
              }
            ]
          },
          "docs": "Move a credential to a position behind another credential"
        },
        {
          "info": {
            "name": "Move a credential to a first position in the credentials list of the user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/credentials/:credentialId/moveToFirst",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "credentialId",
                "value": "",
                "type": "path",
                "description": "The credential to move"
              }
            ]
          },
          "docs": "Move a credential to a first position in the credentials list of the user"
        },
        {
          "info": {
            "name": "Update a credential label for a user",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/credentials/:credentialId/userLabel",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "credentialId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Update a credential label for a user"
        },
        {
          "info": {
            "name": "Disable all credentials for a user of a specific type",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/disable-credential-types",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Disable all credentials for a user of a specific type"
        },
        {
          "info": {
            "name": "Send a update account email to the user   An email contains a link the user can click to perform a set of required actions.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/execute-actions-email",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Client id"
              },
              {
                "name": "lifespan",
                "value": "",
                "type": "query",
                "description": "Number of seconds after which the generated token expires"
              },
              {
                "name": "redirect_uri",
                "value": "",
                "type": "query",
                "description": "Redirect uri"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Send a update account email to the user   An email contains a link the user can click to perform a set of required actions."
        },
        {
          "info": {
            "name": "Get social logins associated with the user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/federated-identity",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Get social logins associated with the user"
        },
        {
          "info": {
            "name": "Add a social login provider to the user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/federated-identity/:provider",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "provider",
                "value": "",
                "type": "path",
                "description": "Social login provider id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Add a social login provider to the user"
        },
        {
          "info": {
            "name": "Remove a social login provider from user",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/federated-identity/:provider",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "provider",
                "value": "",
                "type": "path",
                "description": "Social login provider id"
              }
            ]
          },
          "docs": "Remove a social login provider from user"
        },
        {
          "info": {
            "name": "GET /{realm}/users/{id}/groups",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/groups",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "briefRepresentation",
                "value": "",
                "type": "query"
              },
              {
                "name": "first",
                "value": "",
                "type": "query"
              },
              {
                "name": "max",
                "value": "",
                "type": "query"
              },
              {
                "name": "search",
                "value": "",
                "type": "query"
              }
            ]
          }
        },
        {
          "info": {
            "name": "GET /{realm}/users/{id}/groups/count",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/groups/count",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "search",
                "value": "",
                "type": "query"
              }
            ]
          }
        },
        {
          "info": {
            "name": "PUT /{realm}/users/{id}/groups/{groupId}",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/groups/:groupId",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ]
          }
        },
        {
          "info": {
            "name": "DELETE /{realm}/users/{id}/groups/{groupId}",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/groups/:groupId",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "groupId",
                "value": "",
                "type": "path"
              }
            ]
          }
        },
        {
          "info": {
            "name": "Impersonate the user",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/impersonation",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Impersonate the user"
        },
        {
          "info": {
            "name": "Remove all user sessions associated with the user   Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user.",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/logout",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Remove all user sessions associated with the user   Also send notification to all clients that have an admin URL to invalidate the sessions for the particular user."
        },
        {
          "info": {
            "name": "Get offline sessions associated with the user and client",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/offline-sessions/:clientId",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "clientId",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get offline sessions associated with the user and client"
        },
        {
          "info": {
            "name": "Set up a new password for the user.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/reset-password",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Set up a new password for the user."
        },
        {
          "info": {
            "name": "Send an email-verification email to the user   An email contains a link the user can click to verify their email address.",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/send-verify-email",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              },
              {
                "name": "client_id",
                "value": "",
                "type": "query",
                "description": "Client id"
              },
              {
                "name": "redirect_uri",
                "value": "",
                "type": "query",
                "description": "Redirect uri"
              }
            ]
          },
          "docs": "Send an email-verification email to the user   An email contains a link the user can click to verify their email address."
        },
        {
          "info": {
            "name": "Get sessions associated with the user",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.telekom.de/controlplane/v1/:realm/users/:id/sessions",
            "params": [
              {
                "name": "realm",
                "value": "",
                "type": "path",
                "description": "realm name (not id!)"
              },
              {
                "name": "id",
                "value": "",
                "type": "path",
                "description": "User id"
              }
            ]
          },
          "docs": "Get sessions associated with the user"
        }
      ]
    }
  ],
  "bundled": true
}