Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CreateClient

Hierarchy

Index

Properties

Properties

Optional Readonly child

child?: Core.Graph

curie

curie: "fx:create_client"

links

links: { fx:attributes: Backend.Rels.Attributes; self: Client }

Type declaration

props

props: { client_id: string; client_secret: string; company_logo: string; company_name: string; company_url: string; contact_email: string; contact_name: string; contact_phone: string; date_created: null | string; date_modified: null | string; project_description: string; project_name: string; redirect_uri: string }

Type declaration

  • client_id: string

    A unique identifier for this client. If you do not supply one, one will be automatically generated for you. If you're not hosting the client integration yourself, please use a known prefix when creating your clients. This can not be modified once it is created.

  • client_secret: string

    The password to be used with this client_id for OAuth 2.0 integration. This is generated automatically and can't be changed.

  • company_logo: string

    An image url for this company. This information will be displayed on your OAuth 2.0 authentication page.

  • company_name: string

    The name of the company responsible for this project. This information will be displayed on your OAuth 2.0 authentication page.

  • company_url: string

    The name of the company responsible for this project. This information will be displayed on your OAuth 2.0 authentication page.

  • contact_email: string

    The email address of the individual responsible for this integration.

  • contact_name: string

    The individual responsible for this integration.

  • contact_phone: string

    The phone number of the individual responsible for this integration.

  • date_created: null | string

    The date this resource was created.

  • date_modified: null | string

    The date this resource was last modified.

  • project_description: string

    A description of this project. This information will be displayed on your OAuth 2.0 authentication page.

  • project_name: string

    The name of this project which will be using the API. This should be specific to the installation and implementation of this client. This information will be displayed on your OAuth 2.0 authentication page.

  • redirect_uri: string

    This is the redirection endpoint as described by OAuth 2.0

Optional Readonly zooms

zooms?: Readonly<Record<string, undefined | Core.Graph>>

Generated using TypeDoc