Class: CreateAuthClientInput

api-login/auth/dto/create-auth-client.dto.CreateAuthClientInput

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

Hierarchy

• UpdateAuthClientInput

  ↳ CreateAuthClientInput

Constructors

constructor

• new CreateAuthClientInput()

Inherited from

UpdateAuthClientInput.constructor

Properties

clientCredentialFlowUser

• Optional clientCredentialFlowUser: string

The user to use as subject for the client credential flow.

Inherited from

UpdateAuthClientInput.clientCredentialFlowUser

Defined in

gropius-login-service/backend/src/api-login/auth/dto/update-auth-client.dto.ts:53

---

isValid

• Optional isValid: boolean

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

Defaults to true on create

Example

true

Inherited from

UpdateAuthClientInput.isValid

Defined in

gropius-login-service/backend/src/api-login/auth/dto/update-auth-client.dto.ts:32

---

name

• name: string

The name to set for the auth client.

Must be non empty

Overrides

UpdateAuthClientInput.name

Defined in

gropius-login-service/backend/src/api-login/auth/dto/create-auth-client.dto.ts:10

---

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"]

Inherited from

UpdateAuthClientInput.redirectUrls

Defined in

gropius-login-service/backend/src/api-login/auth/dto/update-auth-client.dto.ts:24

---

requiresSecret

• Optional requiresSecret: boolean

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

Defaults to true on create

Example

false

Inherited from

UpdateAuthClientInput.requiresSecret

Defined in

gropius-login-service/backend/src/api-login/auth/dto/update-auth-client.dto.ts:40

---

validScopes

• Optional validScopes: TokenScope[]

The list of scopes that this client is allowed to request.

Defaults to [] on create

Example

["backend"]

Inherited from

UpdateAuthClientInput.validScopes

Defined in

gropius-login-service/backend/src/api-login/auth/dto/update-auth-client.dto.ts:48

Methods

check

▸ Static check(input): CreateAuthClientInput

Checks whether the input is a valid CreateAuthClientInput

Needed:

• Must be valid UpdateAuthClientInput
• Must have a non empty name

Parameters

Name	Type	Description
input	CreateAuthClientInput	The input object to check

Returns

CreateAuthClientInput

The original input object

Overrides

UpdateAuthClientInput.check

Defined in

gropius-login-service/backend/src/api-login/auth/dto/create-auth-client.dto.ts:22