Skip to main content

Class: CreateOrUpdateAuthClientInput

api-login/dto/create-update-auth-client.dto.CreateOrUpdateAuthClientInput

Input to POST /login/client and PUT /login/client/:id` Contains data to create or modify a auth client

Constructors​

constructor​

• new CreateOrUpdateAuthClientInput()

Properties​

isValid​

• Optional isValid: boolean

If given, sets the validity flag of the auth client.

Defaults to true on create

Example

true

Defined in​

login-service/src/api-login/dto/create-update-auth-client.dto.ts:31

name​

• Optional name: string

The name to set for the auth client.

If given, must be non empty and match /^[a-zA-Z0-9+/-_= ]+$/g

Defined in​

login-service/src/api-login/dto/create-update-auth-client.dto.ts:14

redirectUrls​

• Optional redirectUrls: string[]

A list of url strings containing at least one url. These are the URLs the oauth autorize endpoint will redirect back to

Defaults to [] on create

Example

["https://example.com/oauth/callback?query=value"]

Defined in​

login-service/src/api-login/dto/create-update-auth-client.dto.ts:23

requiresSecret​

• Optional requiresSecret: boolean

If given, setns the need for the client to authenticate using a secret

Defaults to true on create

Example

false

Defined in​

login-service/src/api-login/dto/create-update-auth-client.dto.ts:39

Methods​

check​

▸ Static check(input): CreateOrUpdateAuthClientInput

Checks a given CreateOrUpdateAuthClientInput for validity.

Valid, if:

  • name is not given or a non empty string matching /^[a-zA-Z0-9+/-_= ]+$/g
  • redirectUrls is not given or an array of at least one url
  • isValid is not given or a boolean
  • requiresSecret is not given or a boolean

Parameters​

NameTypeDescription
inputCreateOrUpdateAuthClientInputThe input instance to check

Returns​

CreateOrUpdateAuthClientInput

The given instance unchanged

Defined in​

login-service/src/api-login/dto/create-update-auth-client.dto.ts:52