Class UsersEndpointAdmin

An endpoint for working with Knora users.

Hierarchy

Endpoint
- UsersEndpointAdmin

Index

Constructors

constructor

Properties

Accessors

jsonWebToken

Constructors

constructor

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

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

Parameters
- knoraApiConfig: KnoraApiConfig
- path: string
Returns UsersEndpointAdmin

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

addUserToGroupMembership

addUserToGroupMembership(userIri: string, groupIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:191
Adds a user to a group.

Parameters
- userIri: string
  
  The IRI of the user.
- groupIri: string
  
  The IRI of the group.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

addUserToProjectAdminMembership

addUserToProjectAdminMembership(userIri: string, projectIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:251
Makes a user a project administrator.

Parameters
- userIri: string
  
  The IRI of the user.
- projectIri: string
  
  The IRI of the project.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

addUserToProjectMembership

addUserToProjectMembership(userIri: string, projectIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:221
Adds a user to a project.

Parameters
- userIri: string
  
  The user's IRI.
- projectIri: string
  
  The project's IRI.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

createUser

createUser(user: User): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:130
Creates a user.

Parameters
- user: User
  
  The user to be created.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

deleteUser

deleteUser(iri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:295
Deletes a user. This method does not actually delete a user, but sets the status to false.

Parameters
- iri: string
  
  The IRI of the user to be deleted.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

getUser

getUser(property: "iri" | "email" | "username", value: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:41
Gets a user by a property.

Parameters
- property: "iri" | "email" | "username"
  
  The name of the property by which the user is identified.
- value: string
  
  The value of the property by which the user is identified.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

getUserByEmail

getUserByEmail(email: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:66
Gets a user by email address.

Parameters
- email: string
  
  The email address of the user.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

getUserByIri

getUserByIri(iri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:55
Gets a user by IRI.

Parameters
- iri: string
  
  The IRI of the user.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

getUserByUsername

getUserByUsername(username: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:77
Gets a user by username.

Parameters
- username: string
  
  The username of the user.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

getUserGroupMemberships

getUserGroupMemberships(iri: string): Observable<ApiResponseData<GroupsResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:88
Gets a user's group memberships.

Parameters
- iri: string
  
  The user's IRI.
Returns Observable<ApiResponseData<GroupsResponse> | ApiResponseError>

getUserProjectAdminMemberships

getUserProjectAdminMemberships(iri: string): Observable<ApiResponseData<ProjectsResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:116
Gets a user's project admin memberships.

Parameters
- iri: string
  
  The user's IRI.
Returns Observable<ApiResponseData<ProjectsResponse> | ApiResponseError>

getUserProjectMemberships

getUserProjectMemberships(iri: string): Observable<ApiResponseData<ProjectsResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:102
Gets a user's project memberships.

Parameters
- iri: string
  
  The IRI of the user.
Returns Observable<ApiResponseData<ProjectsResponse> | ApiResponseError>

getUsers

getUsers(): Observable<ApiResponseData<UsersResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:26
Returns a list of all users.

Returns Observable<ApiResponseData<UsersResponse> | 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>

removeUserFromGroupMembership

removeUserFromGroupMembership(userIri: string, groupIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:206
Removes a user from a project.

Parameters
- userIri: string
  
  The IRI of the user.
- groupIri: string
  
  The IRI of the group.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

removeUserFromProjectAdminMembership

removeUserFromProjectAdminMembership(userIri: string, projectIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:266
Removes a user's project administrator status.

Parameters
- userIri: string
  
  The IRI of the user.
- projectIri: string
  
  The IRI of the project.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

removeUserFromProjectMembership

removeUserFromProjectMembership(userIri: string, projectIri: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:236
Removes a user from a project.

Parameters
- userIri: string
  
  The user's IRI.
- projectIri: string
  
  The project's IRI.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

updateUserBasicInformation

updateUserBasicInformation(iri: string, userInfo: UpdateUserRequest): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:145
Updates an existing user's basic information.

Parameters
- iri: string
  
  The IRI of the user to be updated.
- userInfo: UpdateUserRequest
  
  The user information to be updated.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

updateUserPassword

updateUserPassword(iri: string, requesterPassword: string, newPassword: string): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:176
Updates a user's password.

Parameters
- iri: string
  
  The IRI of the user to be updated.
- requesterPassword: string
  
  The requesting user's current password.
- newPassword: string
  
  The specified user's new password.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

updateUserStatus

updateUserStatus(iri: string, status: boolean): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:160
Updates a user's status.

Parameters
- iri: string
  
  The user's IRI.
- status: boolean
  
  The user's new status.
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

updateUserSystemAdminMembership

updateUserSystemAdminMembership(iri: string, systemAdmin: boolean): Observable<ApiResponseData<UserResponse> | ApiResponseError>

- Defined in src/api/admin/users/users-endpoint-admin.ts:281
Updates a user's SystemAdmin membership.

Parameters
- iri: string
  
  The IRI of the user to be updated.
- systemAdmin: boolean
  
  True if the user should be a system admin
Returns Observable<ApiResponseData<UserResponse> | ApiResponseError>

Generated using TypeDoc