Package africa.sendbyte.apikeys

Class ApiKeys

java.lang.Object

africa.sendbyte.apikeys.ApiKeys

public final class ApiKeys
extends Object

The API Keys resource: create scoped keys, list active keys, and revoke keys.

Obtain an instance via client.apiKeys(). These operations require a full_access key. Every method has a blocking form and an ...Async form returning a CompletableFuture.

Constructor Summary

Constructors

Constructor	Description
ApiKeys(RequestExecutor executor)

Method Summary

Modifier and Type	Method	Description
ApiKey	create(String name, KeyScope scope, KeyMode mode)	Create a new API key.
CompletableFuture<ApiKey>	createAsync(String name, KeyScope scope, KeyMode mode)	Asynchronous create(String, KeyScope, KeyMode).
ApiKeyList	list()	List all active (non-revoked) keys.
CompletableFuture<ApiKeyList>	listAsync()	Asynchronous list().
void	revoke(String id)	Revoke a key immediately.
CompletableFuture<Void>	revokeAsync(String id)	Asynchronous revoke(String).

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ApiKeys

public ApiKeys(RequestExecutor executor)

Method Details

create

public ApiKey create(String name,
 KeyScope scope,
 KeyMode mode)

Create a new API key. The full key value is returned once, on ApiKey.getKey() — store it immediately.

Parameters:

name - a human-readable label, e.g. "Production backend"

scope - the permission scope

mode - the environment mode (live or test)

createAsync

public CompletableFuture<ApiKey> createAsync(String name,
 KeyScope scope,
 KeyMode mode)

Asynchronous create(String, KeyScope, KeyMode).

list

public ApiKeyList list()

List all active (non-revoked) keys. Full key values are not included.

listAsync

public CompletableFuture<ApiKeyList> listAsync()

Asynchronous list().

revoke

public void revoke(String id)

Revoke a key immediately. A key cannot revoke itself — use a separate full_access key to perform the revocation.

revokeAsync

public CompletableFuture<Void> revokeAsync(String id)

Asynchronous revoke(String).