parallaxsecond / parsec-book

Parsec documentation
https://parallaxsecond.github.io/parsec-book
Apache License 2.0
12 stars 17 forks source link

Add ListClients and DeleteClient operations #79

Closed hug-dev closed 3 years ago

hug-dev commented 3 years ago

They would both be core operations, adressed to provider ID 0. We should also indicate somehow that concurrency issues with those operations, that if they are executed in parallel with other operations that list/create/delete keys, the result might not be up to date or relevent.

ListClients

Lists all clients currently having keys in the service. Opcode: 27 (0x001B)

Parameters

No parameters are needed for this operation.

Results

Name Type Description
clients Vector of String List of clients

Specific response status codes

No specific response status codes returned.

Description

This operation lists all clients that are currently storing keys in the Parsec service. The clients field contain a vector of the application names used by clients.

This operation necessitates admin privilege.

Only the clients using the same authentication method as this request will be listed. It has no impact currently as only one authentication method in the service is supported but might do if the service supports multiple.

Contract

No contract yet.

DeleteClient

Delete all keys a client has in the service. Opcode: 28 (0x001C)

Parameters

Name Type Description
client String Client to delete

Results

No values are returned by this operation.

Specific response status codes

No specific response status codes returned.

Description

This operation deletes all keys a client owns in all Parsec providers. The client parameter string must be one of the clients returned by the ListClients operation.

This operation necessitates admin privilege.

Only the clients using the same authentication method as this request will be deleted. It has no impact currently as only one authentication method in the service is supported but might do if the service supports multiple.

Contract

No contract yet.