Reference

BackstageClient.identityProviders

BackstageClient.identityProviders in @ticketlayer/backstage.

@ticketlayer/backstage / BackstageClient / identityProviders

identityProviders: {
  get: (id: string, requestOptions?: RequestOptions) => Promise<{
     allowedClientIds: string[];
     authorizationEndpoint: string | null;
     cacheTtl: number;
     clientId: string | null;
     configuration:   | {
      [key: string]: unknown;
      }
        | null;
     createdAt: string;
     emailDomain: string | null;
     id: string;
     isDefault: boolean;
     isEnabled: boolean;
     issuer: string;
     jwksUri: string;
     jwksUriInternal: string | null;
     organisationId: string | null;
     providerType: string;
     scopes: string[];
     supportsPkce: boolean;
     tokenEndpoint: string | null;
     tokenEndpointInternal: string | null;
     updatedAt: string;
     userinfoEndpoint: string | null;
     userinfoEndpointInternal: string | null;
  }>;
  list: (options?: {
     organisationId?: string;
   }, requestOptions?: RequestOptions) => Promise<{
     allowedClientIds: string[];
     authorizationEndpoint: string | null;
     cacheTtl: number;
     clientId: string | null;
     configuration:   | {
      [key: string]: unknown;
      }
        | null;
     createdAt: string;
     emailDomain: string | null;
     id: string;
     isDefault: boolean;
     isEnabled: boolean;
     issuer: string;
     jwksUri: string;
     jwksUriInternal: string | null;
     organisationId: string | null;
     providerType: string;
     scopes: string[];
     supportsPkce: boolean;
     tokenEndpoint: string | null;
     tokenEndpointInternal: string | null;
     updatedAt: string;
     userinfoEndpoint: string | null;
     userinfoEndpointInternal: string | null;
  }[]>;
  update: (id: string, request: {
     allowedClientIds?: string[];
     cacheTtl?: number;
     configuration?: {
      [key: string]: unknown;
     };
     emailDomain?: string | null;
     isDefault?: boolean;
     isEnabled?: boolean;
     scopes?: string[];
   }, requestOptions?: RequestOptions) => Promise<{
     allowedClientIds: string[];
     authorizationEndpoint: string | null;
     cacheTtl: number;
     clientId: string | null;
     configuration:   | {
      [key: string]: unknown;
      }
        | null;
     createdAt: string;
     emailDomain: string | null;
     id: string;
     isDefault: boolean;
     isEnabled: boolean;
     issuer: string;
     jwksUri: string;
     jwksUriInternal: string | null;
     organisationId: string | null;
     providerType: string;
     scopes: string[];
     supportsPkce: boolean;
     tokenEndpoint: string | null;
     tokenEndpointInternal: string | null;
     updatedAt: string;
     userinfoEndpoint: string | null;
     userinfoEndpointInternal: string | null;
  }>;
};

Defined in: client.ts:2448

Identity Providers methods

get()#

get: (id: string, requestOptions?: RequestOptions) => Promise<{
  allowedClientIds: string[];
  authorizationEndpoint: string | null;
  cacheTtl: number;
  clientId: string | null;
  configuration:   | {
   [key: string]: unknown;
   }
     | null;
  createdAt: string;
  emailDomain: string | null;
  id: string;
  isDefault: boolean;
  isEnabled: boolean;
  issuer: string;
  jwksUri: string;
  jwksUriInternal: string | null;
  organisationId: string | null;
  providerType: string;
  scopes: string[];
  supportsPkce: boolean;
  tokenEndpoint: string | null;
  tokenEndpointInternal: string | null;
  updatedAt: string;
  userinfoEndpoint: string | null;
  userinfoEndpointInternal: string | null;
}>;

Get identity provider Get a specific identity provider by ID

Parameters#

Parameter	Type
`id`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Promise<{ allowedClientIds: string[]; authorizationEndpoint: string | null; cacheTtl: number; clientId: string | null; configuration: | { [key: string]: unknown; } | null; createdAt: string; emailDomain: string | null; id: string; isDefault: boolean; isEnabled: boolean; issuer: string; jwksUri: string; jwksUriInternal: string | null; organisationId: string | null; providerType: string; scopes: string[]; supportsPkce: boolean; tokenEndpoint: string | null; tokenEndpointInternal: string | null; updatedAt: string; userinfoEndpoint: string | null; userinfoEndpointInternal: string | null; }>

Operation Id#

getIdentityProvider

list()#

list: (options?: {
  organisationId?: string;
}, requestOptions?: RequestOptions) => Promise<{
  allowedClientIds: string[];
  authorizationEndpoint: string | null;
  cacheTtl: number;
  clientId: string | null;
  configuration:   | {
   [key: string]: unknown;
   }
     | null;
  createdAt: string;
  emailDomain: string | null;
  id: string;
  isDefault: boolean;
  isEnabled: boolean;
  issuer: string;
  jwksUri: string;
  jwksUriInternal: string | null;
  organisationId: string | null;
  providerType: string;
  scopes: string[];
  supportsPkce: boolean;
  tokenEndpoint: string | null;
  tokenEndpointInternal: string | null;
  updatedAt: string;
  userinfoEndpoint: string | null;
  userinfoEndpointInternal: string | null;
}[]>;

List identity providers List all identity providers for the organisation

Parameters#

Parameter	Type
`options?`	{ `organisationId?`: `string`; }
`options.organisationId?`	`string`
`requestOptions?`	`RequestOptions`

Returns#

Operation Id#

listIdentityProviders

update()#

update: (id: string, request: {
  allowedClientIds?: string[];
  cacheTtl?: number;
  configuration?: {
   [key: string]: unknown;
  };
  emailDomain?: string | null;
  isDefault?: boolean;
  isEnabled?: boolean;
  scopes?: string[];
}, requestOptions?: RequestOptions) => Promise<{
  allowedClientIds: string[];
  authorizationEndpoint: string | null;
  cacheTtl: number;
  clientId: string | null;
  configuration:   | {
   [key: string]: unknown;
   }
     | null;
  createdAt: string;
  emailDomain: string | null;
  id: string;
  isDefault: boolean;
  isEnabled: boolean;
  issuer: string;
  jwksUri: string;
  jwksUriInternal: string | null;
  organisationId: string | null;
  providerType: string;
  scopes: string[];
  supportsPkce: boolean;
  tokenEndpoint: string | null;
  tokenEndpointInternal: string | null;
  updatedAt: string;
  userinfoEndpoint: string | null;
  userinfoEndpointInternal: string | null;
}>;

Update identity provider Update an identity provider configuration

Parameters#

Parameter	Type	Description
`id`	`string`	-
`request`	{ `allowedClientIds?`: `string`[]; `cacheTtl?`: `number`; `configuration?`: { [`key`: `string`]: `unknown`; }; `emailDomain?`: `string` \| `null`; `isDefault?`: `boolean`; `isEnabled?`: `boolean`; `scopes?`: `string`[]; }	-
`request.allowedClientIds?`	`string`[]	Example `[ "backstage-app" ]`
`request.cacheTtl?`	`number`	Example `600`
`request.configuration?`	{ [`key`: `string`]: `unknown`; }	Example `{}`
`request.emailDomain?`	`string` \| `null`	Example `@example.com`
`request.isDefault?`	`boolean`	Example `false`
`request.isEnabled?`	`boolean`	Example `true`
`request.scopes?`	`string`[]	Example `[ "openid", "profile", "email" ]`
`requestOptions?`	`RequestOptions`	-

Returns#

Operation Id#

updateIdentityProvider