Skip to main content

Class: GetAuthClientResponse

api-login/auth/dto/get-auth-client.dto.GetAuthClientResponse

Response of GET for one single auth client. Same as AuthClient extended by censoredClientSecrets

Constructors​

constructor​

• new GetAuthClientResponse()

Properties​

censoredClientSecrets​

• censoredClientSecrets: CensoredClientSecret[]

A list of a representation of all client secrets.

Includes the fingerprint of the has of the secret as identifying field and a censored version (5 char prefix) of the original secret text for easier idenfication by users

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:45

clientCredentialFlowUser​

• Optional clientCredentialFlowUser: string

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

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:50

id​

• id: string

The unique ID of this client

Example

12345678-90ab-cdef-fedc-ab0987654321

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:11

isValid​

• isValid: boolean

If this is false the client is not valid and no authorization, token, ... requests from it should be answered.

Example

true

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:28

redirectUrls​

• redirectUrls: string[]

The list of valid enpoints to redirect the user back to after authentication has finished.

The actual url to use is given in the authorize request and must be included in this list. If none is given, the first one from this list will be used

Example

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

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:21

requiresSecret​

• requiresSecret: boolean

If true requesting a token as this client requires the use of a client secret accoring to the oauth specification.

If false client secrets can be present and given but are not required

Example

false

Defined in​

gropius-login-service/backend/src/api-login/auth/dto/get-auth-client.dto.ts:37