AuthenticationEndpointV2 | @dasch-swiss/dsp-js API Documentation

Handles requests to the authentication route of the Knora API.

Hierarchy

Endpoint
- AuthenticationEndpointV2

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Methods

Constructors

constructor

new AuthenticationEndpointV2(knoraApiConfig: KnoraApiConfig, path: string): AuthenticationEndpointV2

Inherited from Endpoint.constructor
- Defined in src/api/endpoint.ts:50
Constructor.

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns AuthenticationEndpointV2

Properties

jsonConvert

jsonConvert: JsonConvert = new JsonConvert(OperationMode.ENABLE,ValueCheckingMode.DISALLOW_NULL,false,PropertyMatchingRule.CASE_STRICT)

JsonConvert instance

Protected knoraApiConfig

knoraApiConfig: KnoraApiConfig

Protected path

path: string

Accessors

jsonWebToken

get jsonWebToken(): string
set jsonWebToken(value: string): void

Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:41
The session token

Returns string
Inherited from Endpoint.jsonWebToken
- Defined in src/api/endpoint.ts:48
The session token

Parameters
- value: string
Returns void

Methods

checkCredentials

checkCredentials(): Observable<ApiResponseData<CredentialsResponse> | ApiResponseError>

- Defined in src/api/v2/authentication/authentication-endpoint-v2.ts:68
Checks credentials.

Returns a ApiResponseError if the client is not authorized.

Returns Observable<ApiResponseData<CredentialsResponse> | ApiResponseError>

Protected handleError

handleError(error: AjaxError | DataError): Observable<ApiResponseError>

Inherited from Endpoint.handleError
- Defined in src/api/endpoint.ts:150
Handles parsing errors.

Parameters
- error: AjaxError | DataError
  
  the error class provided by us
Returns Observable<ApiResponseError>

Protected httpDelete

httpDelete(path?: undefined | string): Observable<AjaxResponse>

Inherited from Endpoint.httpDelete
- Defined in src/api/endpoint.ts:138
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpGet

httpGet(path?: undefined | string): Observable<AjaxResponse>

Inherited from Endpoint.httpGet
- Defined in src/api/endpoint.ts:80
Performs a general GET request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
Returns Observable<AjaxResponse>

Protected httpPatch

httpPatch(path?: undefined | string, body?: any, contentType?: "json"): Observable<AjaxResponse>

Inherited from Endpoint.httpPatch
- Defined in src/api/endpoint.ts:125
Performs a general PATCH request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

Protected httpPost

httpPost(path?: undefined | string, body?: any, contentType?: "json" | "sparql"): Observable<AjaxResponse>

Inherited from Endpoint.httpPost
- Defined in src/api/endpoint.ts:95
Performs a general POST request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request, if any.
- Default value contentType: "json" | "sparql" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

Protected httpPut

httpPut(path?: undefined | string, body?: any, contentType?: "json"): Observable<AjaxResponse>

Inherited from Endpoint.httpPut
- Defined in src/api/endpoint.ts:110
Performs a general PUT request.

Parameters
- Optional path: undefined | string
  
  the relative URL for the request
- Optional body: any
  
  the body of the request
- Default value contentType: "json" = "json"
  
  content content type of body, if any.
Returns Observable<AjaxResponse>

login

login(property: "iri" | "email" | "username", id: string, password: string): Observable<ApiResponseData<LoginResponse> | ApiResponseError>

- Defined in src/api/v2/authentication/authentication-endpoint-v2.ts:26
Logs in a user.

Parameters
- property: "iri" | "email" | "username"
  
  The name of the property by which the user is identified.
- id: string
  
  the given user.
- password: string
  
  the user's password.
Returns Observable<ApiResponseData<LoginResponse> | ApiResponseError>

logout

logout(): Observable<ApiResponseData<LogoutResponse> | ApiResponseError>

- Defined in src/api/v2/authentication/authentication-endpoint-v2.ts:49
Logs out the user and destroys the session on the server- and client-side.

Returns Observable<ApiResponseData<LogoutResponse> | ApiResponseError>

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

knoraApiConfig: KnoraApiConfig

path: string

Returns AuthenticationEndpointV2

Properties

jsonConvert

Protected knoraApiConfig

Protected path

Accessors

jsonWebToken

Returns string

Parameters

value: string

Returns void

Methods

checkCredentials

Returns Observable<ApiResponseData<CredentialsResponse> | ApiResponseError>

Protected handleError

Parameters

error: AjaxError | DataError

Returns Observable<ApiResponseError>

Protected httpDelete

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpGet

Parameters

Optional path: undefined | string

Returns Observable<AjaxResponse>

Protected httpPatch

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>

Protected httpPost

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" | "sparql" = "json"

Returns Observable<AjaxResponse>

Protected httpPut

Parameters

Optional path: undefined | string

Optional body: any

Default value contentType: "json" = "json"

Returns Observable<AjaxResponse>

login

Parameters

property: "iri" | "email" | "username"

id: string

password: string

Returns Observable<ApiResponseData<LoginResponse> | ApiResponseError>

logout

Returns Observable<ApiResponseData<LogoutResponse> | ApiResponseError>