Class OAuthClient

Provides properties and methods for obtaining information about a OAuth 2.0 client that have access the Open Cloud Server API.

Hierarchy (View Summary)

Constructors

Properties

headers: HeadersInit

Endpoint-specific HTTP headers for the GET, POST, PUT and DELETE requests. You can add custom headers at any time.

path: string

Endpoint API path relative to the REST API server URL.

Accessors

  • get accessTokenUrl(): string
  • OAuth 2.0 server token endpoint.

    Returns string

  • get authUrl(): string
  • OAuth 2.0 server authorization endpoint.

    Returns string

  • get clientId(): string
  • Unique client ID.

    Returns string

  • get createdAt(): string
  • Client creation time (UTC) in the format specified in ISO 8601.

    Returns string

  • get description(): string
  • Client application description.

    Returns string

  • get name(): string
  • Client application name.

    Returns string

  • get redirectUrl(): string
  • The endpoint to which the OAuth 2.0 server sends the response.

    Returns string

  • get secret(): string
  • Client secret.

    Returns string

  • get updatedAt(): string
  • Client last update time (UTC) in the format specified in ISO 8601.

    Returns string

Methods

  • Deletes a client from the server.

    Only administrators can delete OAuth clients. If the current logged in user is not an administrator, an exception will be thrown.

    Returns Promise<any>

    Returns the raw data of a deleted client. For more information, see Open Cloud OAuth Clients API.

  • Revokes the access tokens for all users of the client application.

    Returns Promise<OAuthClient>

  • Saves client properties changes to the server. Call this method to update client data on the server after any property changes.

    Only administrators can update OAuth clients. If the current logged in user is not an administrator, an exception will be thrown.

    Returns Promise<OAuthClient>

  • Updates client data on the server.

    Only administrators can update OAuth clients. If the current logged in user is not an administrator, an exception will be thrown.

    Parameters

    Returns Promise<OAuthClient>