@oystehr/sdk/src/resources/types/M2m.ts

Oystehr SDK

// AUTOGENERATED -- DO NOT EDIT

import { AccessPolicy } from './AccessPolicy';
import { RoleStub } from './RoleStub';

export interface M2m {
  id: string;
  /**
   * The OAuth 2.0 client identifier for the M2M Client. Use this, combined with the client secret (from the `rotate-secret` endpoint), to authenticate with the OAuth 2.0 client credentials flow and receive an access token.
   */
  clientId: string;
  /**
   * Reference to the FHIR Device resource that represents the M2M Client in the FHIR store.
   */
  profile: string;
  /**
   * An URL of JWK set used for getting an access token by signed authentication JWT
   */
  jwksUrl?: string;
  /**
   * A name for the M2M Client to help you differentiate it from other M2M Clients in the project.
   */
  name: string;
  /**
   * A description of the M2M Client to help you differentiate it from other M2M Clients in the project.
   */
  description?: string;
  accessPolicy?: AccessPolicy;
  /**
   * A list of roles assigned to this M2M Client
   */
  roles: RoleStub[];
}