Get a Client

v1.0.0

Use this endpoint to generate a random client. The client is generated in a deterministic way, on the bases of the client ID given as a path parameter. In the case of identical client IDs, the endpoint will generate the same client object. The properties of the generated client object are randomly generated on the basis of the client ID. In lack of a client ID, all calls generate a different client object to the randomly generated client ID.

By providing an email address as the client_id parameter, you can customize the client logo by the use of the gravatar associated with the email address.

If the client_id parameter contains minimum one dot (.) or space ( ) character, the client_name is produced from the parameter, rather than being generated.`

The result is always a client object. If you want to generate multiple clients in one single step, you can do it by the use of Fleet generation. The members of a fleet are clients randomly generated from the fleet name.

Input

{
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string"
    }
  },
  "required": [
    "client_id"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "required": [
    "client_id"
  ],
  "properties": {
    "@id": {
      "type": "string",
      "description": "URL of the Client's JSON representation."
    },
    "client_id": {
      "type": "string",
      "description": "OAuth 2.0 client identifier string."
    },
    "client_name": {
      "type": "string",
      "description": "Human-readable string name of the client to be presented to the end-user during authorization."
    },
    "client_secret": {
      "type": "string",
      "description": "OAuth 2.0 client secret string. "
    },
    "client_uri": {
      "type": "string",
      "description": "URL string of a web page providing information about the client."
    },
    "contacts": {
      "type": "array",
      "description": "Array of strings representing ways to contact people responsible for this client, typically email addresses.",
      "items": {
        "type": "object"
      }
    },
    "grant_types": {
      "type": "array",
      "description": "Array of OAuth 2.0 grant type strings that the client can use at the token endpoint.",
      "items": {
        "type": "object"
      }
    },
    "jwks": {
      "type": "array",
      "description": "Client's JSON Web Key Set [RFC7517] document value, which contains the client's public keys.  The value of this field MUST be a JSON object containing a valid JWK Set.",
      "items": {
        "type": "object"
      }
    },
    "jwks_uri": {
      "type": "string",
      "description": "URL string referencing the client's JSON Web Key (JWK) Set [RFC7517] document, which contains the client's public keys."
    },
    "logo_email": {
      "type": "string",
      "description": "An email address used to generate a gravatar.com logo_uri."
    },
    "logo_uri": {
      "type": "string",
      "description": "URL string that references a logo for the client."
    },
    "policy_uri": {
      "type": "string",
      "description": "URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data."
    },
    "redirect_uris": {
      "type": "array",
      "description": "Array of redirection URI strings for use in redirect-based flows such as the authorization code and implicit flows.",
      "items": {
        "type": "object"
      }
    },
    "response_types": {
      "type": "array",
      "description": "Array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint.",
      "items": {
        "type": "object"
      }
    },
    "scope": {
      "type": "string",
      "description": "String containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens."
    },
    "software_id": {
      "type": "string",
      "description": "A unique identifier string (e.g., a Universally Unique Identifier (UUID)) assigned by the client developer or software publisher used by registration endpoints to identify the client software to be dynamically registered."
    },
    "software_version": {
      "type": "string",
      "description": "A version identifier string for the client software identified by software_id."
    },
    "token_endpoint_auth_method": {
      "type": "string",
      "description": "String indicator of the requested authentication method for the token endpoint."
    },
    "tos_uri": {
      "type": "string",
      "description": "URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client."
    }
  }
}