Description Usage Format Details Fields Methods
rAgave.Clients
1 |
An object of class R6ClassGenerator
of length 24.
The Clients API is the client registration service for the Agave Platform. This service is in charge of issuing and managing API keys for your client applications as well as its subscriptions to boutique APIs availabled from within your tenant.
1 2 3 4 5 |
path
Stores url path of the request.
apiClient
Handles the client-server communication.
userAgent
Set the user agent of the request.
$create(body, updateCache)
Creates a new client. Client names must be
unique within a tenant. Attempting to create a client with an existing
name will fail notifying you of the name conflict. If you already own
a client with the given name, but have lost the key, you may delete the
existing client and create a new one with the same name. Setting
updateCache to FALSE will prevent the client key and secret from being
written to your local auth cache. The default is TRUE.
Usage
1 2 3 4 5 |
$addSubscription(clientName, body)
Subscribe to an API. You must have been granted
access to the API by the author before you can subscribe. Every new client
is subsribed to all the core science API by default.
Usage
1 2 | subscriptionRequest <- ClientSubscriptionRequest(apiName="Tags", apiProvider="admin", apiVersion="v2", tier="UNLIMITED")
clients$addSubscription(clientName="my_client", body=subscriptionRequest)
|
$clearSubscriptions(clientName)
Unsubscribe the client from all API to
which it is currently subscribed.
Usage
1 | clients$clearSubscriptions(clientName="my_client")
|
$delete(clientName)
Delete the given client. This will invalidate the
client's keys and any outstanding, active tokens it has.
Usage
1 | clients$delete(clientName="my_client")
|
$getDetails(clientName)
Fetch the client details. Note that the client
secret will not be returned once the client is created.
Usage
1 | clients$getDetails(clientName="my_client")
|
$listSubscriptions(clientName)
List all API to which the client is
subscribed.
Usage
1 | clients$listSubscriptions(clientName="my_client")
|
$list()
list all clients for the autehnticated user
Usage
1 | clients$list()
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.