.wpb_animate_when_almost_visible { opacity: 1; }
User Details France
Enrich your service with user profile information.

User Details FR API

Unless otherwise specified, the User Details API endpoints require a user authentication. This means you must provide a bearer Authorization header with a valid access token for each API call.
[BASE URL: /userdetails/v2/userinfo, API VERSION: 2.0, HOST: https://api.orange.com]
    • implementation notes

      Returns the status

      response class (status 200)
      {
        "name": "user_details_v2",
        "status": "ok",
        "version": "2.0.0",
        "components": [
          {
            "name": "OIDC FR",
            "status": "ok",
            "version": "1.0.0",
            "components": [
              {
                "name": "OpenIdConnectServer",
                "status": "ok",
                "version": "G1R14C0",
                "moreInfo": {
                  "hostnamename": "OIEPR-NODEJS-04",
                  "memoryUsage": {
                    "rss": 98353152,
                    "heapTotal": 71334240,
                    "heapUsed": 55645800,
                    "heapUsedFraction": 78.00713934850921,
                    "osFreeMem": 462442496
                  },
                  "loadavg": [
                    0.04638671875,
                    0.11328125,
                    0.1435546875
                  ]
                }
              },
              {
                "name": "generic_token_introspection_v1",
                "status": "ok",
                "version": "1.0.1",
                "components": [
                  {
                    "name": "OpenIdConnectTokenManagementApi OFR",
                    "status": "ok",
                    "version": "4.0.0"
                  }
                ],
                "httpStatusCode": 200
              }
            ]
          }
        ]
      }
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      503http status
      {
        "name": "user_details_v2",
        "status": "ok",
        "version": "2.0.0",
        "components": [
          {
            "name": "OIDC FR",
            "status": "ok",
            "version": "1.0.0",
            "components": [
              {
                "name": "OpenIdConnectServer",
                "status": "ok",
                "version": "G1R14C0",
                "moreInfo": {
                  "hostnamename": "OIEPR-NODEJS-04",
                  "memoryUsage": {
                    "rss": 98353152,
                    "heapTotal": 71334240,
                    "heapUsed": 55645800,
                    "heapUsedFraction": 78.00713934850921,
                    "osFreeMem": 462442496
                  },
                  "loadavg": [
                    0.04638671875,
                    0.11328125,
                    0.1435546875
                  ]
                }
              },
              {
                "name": "generic_token_introspection_v1",
                "status": "ok",
                "version": "1.0.1",
                "components": [
                  {
                    "name": "OpenIdConnectTokenManagementApi OFR",
                    "status": "ok",
                    "version": "4.0.0"
                  }
                ],
                "httpStatusCode": 200
              }
            ]
          }
        ]
      }
      defaultError
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • implementation notes

      To invoke the User Details API, you need to provide the obtained "access token".

      response class (status 200)
      {
        "sub": "string",
        "name": "string"
      }
      parameters
      parametervaluedescriptionparameter typedata type
      (required)
      The Authorization with a valid tokenheaderstring
      response messages
      List of common error codes
      HTTP status codereasonresponse model
      400List of error codes:
      - invalid_request: the request is missing a required parameter, includes an unsupported parameter or parameter value, repeats the same parameter, uses more than one method for including an access token.
      {
        "error": "string",
        "error_description": "string"
      }
      401List of error codes:
      - invalid_token: the access token provided is expired, revoked, malformed, or invalid for other reasons.
      {
        "error": "string",
        "error_description": "string"
      }
      403List of error codes:
      - insufficient_scope: the request requires higher privileges than provided by the access token.
      {
        "error": "string",
        "error_description": "string"
      }
      404List of error codes:
      - invalid_request: the requested URI or the requested resource does not exist.
      {
        "error": "string",
        "error_description": "string"
      }
      405List of error codes:
      - invalid_request: the URI does not support the requested method.
      {
        "error": "string",
        "error_description": "string"
      }
      500List of error codes:
      - server_error: the userinfo endpoint encountered an unexpected condition that prevented it from fulfilling the request.
      {
        "error": "string",
        "error_description": "string"
      }
      defaultCommon error list
      {
        "code": 23,
        "message": "Missing body field",
        "description": "The field 'productionDate' is missing from posted body"
      }
    • HTTP status codereasonresponse model
      400List of supported error codes:
      - 20: Invalid URL parameter value
      - 21: Missing body
      - 22: Invalid body
      - 23: Missing body field
      - 24: Invalid body field
      - 25: Missing header
      - 26: Invalid header value
      - 27: Missing query-string parameter
      - 28: Invalid query-string parameter value
      {
        "code": 28,
        "message": "Invalid query-string parameter value",
        "description": "One or more query-string parameters contain invalid values."
      }
      401List of supported error codes:
      - 40: Missing credentials
      - 41: Invalid credentials
      - 42: Expired credentials
      {
        "code": 42,
        "message": "Expired credentials",
        "description": "The requested service needs credentials, and the ones provided were out-of-date."
      }
      403List of supported error codes:
      - 50: Access denied
      - 51: Forbidden requester
      - 52: Forbidden user
      - 53: Too many requests
      {
        "code": 53,
        "message": "Too many requests",
        "description": "The application has made too many calls and has exceeded the rate limit for this service."
      }
      404List of supported error codes:
      - 60: Resource not found
      {
        "code": 60,
        "message": "Resource not found",
        "description": "The requested URI or the requested resource does not exist."
      }
      405List of supported error codes:
      - 61: Method not allowed
      {
        "code": 61,
        "message": "Method not allowed",
        "description": "The URI does not support the requested method. The available methods should be set in the response header 'Allow'"
      }
      406List of supported error codes:
      - 62: Not acceptable
      {
        "code": 62,
        "message": "Not acceptable",
        "description": "The Accept incoming header does not match any available content-type."
      }
      408List of supported error codes:
      - 63: Request time-out
      {
        "code": 63,
        "message": "Request time-out",
        "description": "The server timed out waiting for the incoming request."
      }
      411List of supported error codes:
      - 64: Length required
      {
        "code": 64,
        "message": "Length required",
        "description": "The request did not specify a Content-Length header, which is required by the requested resource."
      }
      412List of supported error codes:
      - 65: Precondition failed
      {
        "code": 65,
        "message": "Precondition failed",
        "description": "One of the precondition request headers (aka. 'If-None-Match', 'If-Match', 'If-Modified-Since', and 'If-Unmodified-Since') failed to match."
      }
      413List of supported error codes:
      - 66: Request entity too large
      {
        "code": 66,
        "message": "Request entity too large",
        "description": "The body of a request (PATCH, POST and PUT methods) is larger than the server is willing or able to process."
      }
      414List of supported error codes:
      - 67: Request-URI too long
      {
        "code": 67,
        "message": "Request-URI too long",
        "description": "The URI provided was too long for the server to process."
      }
      415List of supported error codes:
      - 68: Unsupported Media Type
      {
        "code": 68,
        "message": "Unsupported Media Type",
        "description": "The format of the posted body is not supported by the endpoint."
      }
      500List of supported error codes:
      - 1: Internal error
      {
        "code": 1,
        "message": "internal error",
        "description": "Generic failure message, used if no more precise code can be provided."
      }
      503List of supported error codes:
      - 5: The service is temporarily unavailable
      - 6: Orange API is over capacity, retry later !
      {
        "code": 6,
        "message": "Orange API is over capacity, retry later !",
        "description": "The service faces too much requests and can not handle the call."
      }