Class ApiKeyService

Class representing a set of API key-related functionality.

Inheritance
System.Object
EasyPostService
ApiKeyService
Implements
IDisposable
Inherited Members
Namespace: EasyPost.Services
Assembly: EasyPost.dll
Syntax
public class ApiKeyService : EasyPostService, IEasyPostService

Methods

| Improve this Doc View Source

All(CancellationToken)

Get a list of all ApiKeys. Related API documentation.

Declaration
public async Task<ApiKeyCollection> All(CancellationToken cancellationToken = null)
Parameters
Type Name Description
CancellationToken cancellationToken

to use for the HTTP request.
Returns
Type Description
Task<ApiKeyCollection>

A ApiKeyCollection object.
| Improve this Doc View Source

RetrieveApiKeysForUser(String, CancellationToken)

Retrieve the ApiKeys for a specific User.

Declaration
public async Task<List<ApiKey>?> RetrieveApiKeysForUser(string id, CancellationToken cancellationToken = null)
Parameters
Type Name Description
System.String id

The ID of the User to retrieve keys for.
CancellationToken cancellationToken

to use for the HTTP request.
Returns
Type Description
Task<System.Nullable<List<ApiKey>>>

A list of ApiKeys for the specified User.
Exceptions
Type Condition
FilteringError

Thrown if the specified User does not exist.

Implements

IDisposable