Red Hat Summit Red Hat SummitSupportConsoleDéveloppeursCommencer un essaiContact

Ce contenu n'est pas disponible dans la langue sélectionnée.

Chapter 4. User Information

This chapter provides information on API resources that allow a client to manage OpenShift user account information.
The following table describes each parameter associated with a user account.
Expand
Name Description
capabilities Map of user capabilities. See the following table for user capabilities.
consumed_gears Total number of gears consumed by all applications owned by user.
login Account user name.
max_gears Maximum number of gears available to the specified user.
max_teams Maximum number of teams a user can create.
plan_id Subscription plan of the specified user.
plan_state State of the account for the specified user.
The following table further describes each available capability for the user.
Expand
Name Description
plan_upgrade_enabled Indicates whether the user is on an upgraded plan.
subaccounts Indicates whether the user has the ability to create subaccounts.
gear_sizes Available gear sizes depending on the type of plan.
max_storage_per_gear Maximum storage in gigabytes available per gear to the specified user.
private_ssl_certificates Subscription plan of the specified user.

4.1. View User Information
Copier lien

Description

Provides resource links to view user information, and manage user SSH keys.

Method and URL Structure

Expand
Method Resource URL
GET /broker/rest/user

Request Parameters

Not applicable

cURL Command Example

$ curl -X GET https://openshift.redhat.com/broker/rest/user --user user@example.com:password
Copy to Clipboard Toggle word wrap

JSON Response

The API returns the user information resource. Unnecessary information and related resource links returned by the API have been removed for brevity. See Chapter 4, User Information for more information on all user information parameters. 

{
    "api_version": 1.6,
    "data": {
        "capabilities": {
            "subaccounts": true,
            "gear_sizes": [
                "small",
                "medium"
            ],
            "plan_upgrade_enabled": true,
            "private_ssl_certificates": true,
            "inherit_on_subaccounts": [
                "gear_sizes"
            ]
        },
        "consumed_gears": 2,
        "created_at": "2013-08-14T19:12:59Z",
        "id": "520bd6bbdbd93c3dee00000d",
        "links": {
            "ADD_KEY": {
                "href": "https://openshift.redhat.com/broker/rest/user/keys",
                "method": "POST",
                "optional_params": [],
                "rel": "Add new SSH key",
                "required_params": [
                    {
                        "description": "Name of the key",
                        "invalid_options": [],
                        "name": "name",
                        "type": "string",
                        "valid_options": []
                    },
                    {
                        "description": "Type of Key",
                        "invalid_options": [],
                        "name": "type",
                        "type": "string",
                        "valid_options": [
                            "ssh-rsa",
                            "ssh-dss",
                            "ssh-rsa-cert-v01@openssh.com",
                            "ssh-dss-cert-v01@openssh.com",
                            "ssh-rsa-cert-v00@openssh.com",
                            "ssh-dss-cert-v00@openssh.com"
                        ]
                    },
                    {
                        "description": "The key portion of an rsa key (excluding ssh-rsa and comment)",
                        "invalid_options": [],
                        "name": "content",
                        "type": "string",
                        "valid_options": []
                    }
                ]
            },
            "LIST_KEYS": {
                "href": "https://openshift.redhat.com/broker/rest/user/keys",
                "method": "GET",
                "optional_params": [],
                "rel": "List SSH keys",
                "required_params": []
            }
        },
        "login": "user@example.com",
        "max_gears": 10,
        "plan_id": "free",
        "plan_state": "ACTIVE",
        "usage_account_id": null
    },
    "messages": [],
    "status": "ok",
    "supported_api_versions": [
      1.0,
      1.1,
      1.2,
      1.3,  
      1.4,
      1.5,
      1.6
    ],
    "type": "user",
    "version": "1.6"
}
Copy to Clipboard Toggle word wrap

Retour au début
Red Hat logoGithubredditYoutubeTwitter

Apprendre

Essayez, achetez et vendez

Communautés

À propos de la documentation Red Hat

Nous aidons les utilisateurs de Red Hat à innover et à atteindre leurs objectifs grâce à nos produits et services avec un contenu auquel ils peuvent faire confiance. Découvrez nos récentes mises à jour.

Rendre l’open source plus inclusif

Red Hat s'engage à remplacer le langage problématique dans notre code, notre documentation et nos propriétés Web. Pour plus de détails, consultez le Blog Red Hat.

À propos de Red Hat

Nous proposons des solutions renforcées qui facilitent le travail des entreprises sur plusieurs plates-formes et environnements, du centre de données central à la périphérie du réseau.

Theme

© 2025 Red Hat