clients¶
Summary: Create and manage API keys. Requires HTTP BASIC authentication
create: Create a new client¶
clients.create(body=<BODY>)
Keyword Args:¶
- body: The api client to create (JSON, ClientRequest)
ClientRequest schema
{
"$id": "http://agavepy.readthedocs.io/en/latest/ClientRequest.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"callbackUrl": {
"description": "Callback URL for OAuth authentication grant.",
"type": "string"
},
"description": {
"description": "Description of the client. This will be shown to users when authentication via OAuth web flows",
"type": "string"
},
"name": {
"description": "The name of the client.",
"type": "string"
},
"tier": {
"description": "The access tier for this client.",
"enum": [
"UNLIMITED",
"GOLD",
"SILVER",
"BRONZE"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AgavePy ClientRequest schema",
"type": "object"
}
Response:¶
- A single Client object
list: List existing clients¶
clients.list()
ClientRequest schema
{
"$id": "http://agavepy.readthedocs.io/en/latest/ClientRequest.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"properties": {
"callbackUrl": {
"description": "Callback URL for OAuth authentication grant.",
"type": "string"
},
"description": {
"description": "Description of the client. This will be shown to users when authentication via OAuth web flows",
"type": "string"
},
"name": {
"description": "The name of the client.",
"type": "string"
},
"tier": {
"description": "The access tier for this client.",
"enum": [
"UNLIMITED",
"GOLD",
"SILVER",
"BRONZE"
],
"type": "string"
}
},
"required": [
"name"
],
"title": "AgavePy ClientRequest schema",
"type": "object"
}
Response:¶
- Array of Client objects
delete: Immediately deletes this client and renders the API keys useless.¶
clients.delete(clientName=<CLIENTNAME>)
Keyword Args:¶
- clientName: The name of the client to be deleted (string)
Response:¶
- A single String object
getClientByName: Returns a detailed description of a named client.¶
clients.getClientByName(clientName=<CLIENTNAME>)
Keyword Args:¶
- clientName: The name of the client to be deleted (string)
Response:¶
- Array of Client objects
addSubscriptionForClient: Lists all APIs to which the client is subscribed¶
clients.addSubscriptionForClient(body=<BODY>, clientName=<CLIENTNAME>)
Keyword Args:¶
- body: The api client to create (JSON, ClientSubscriptionRequest)
- clientName: The name of the client to be subscribe to this api (string)
Response:¶
- A single Subscription object