Skip to content

README.md

Latest commit

 

History

History
327 lines (241 loc) · 20.7 KB

README.md

File metadata and controls

327 lines (241 loc) · 20.7 KB
Raw

Vault.Consumers

Overview

Available Operations

create

Create a consumer

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ConsumerMetadata;
import com.apideck.unify.models.components.CreateConsumerRequest;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.VaultConsumersAddResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        VaultConsumersAddResponse res = sdk.vault().consumers().create()
                .createConsumerRequest(CreateConsumerRequest.builder()
                    .consumerId("test_consumer_id")
                    .metadata(ConsumerMetadata.builder()
                        .accountName("SpaceX")
                        .userName("Elon Musk")
                        .email("elon@musk.com")
                        .image("https://www.spacex.com/static/images/share.jpg")
                        .build())
                    .build())
                .call();

        if (res.createConsumerResponse().isPresent()) {
            System.out.println(res.createConsumerResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
createConsumerRequest CreateConsumerRequest ✔️ N/A

Response

VaultConsumersAddResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/UnprocessableResponse 422 application/json
models/errors/APIException 4XX, 5XX */*

list

This endpoint includes all application consumers, along with an aggregated count of requests made.

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ConsumersFilter;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.VaultConsumersAllResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();


        sdk.vault().consumers().list()
                .filter(ConsumersFilter.builder()
                    .consumerId("test-consumer")
                    .search("john")
                    .build())
                .limit(20L)
                .callAsStream()
                .forEach((VaultConsumersAllResponse item) -> {
                   // handle page
                });

    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
filter Optional<ConsumersFilter> ➖ Filter results
cursor JsonNullable<String> ➖ Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
limit Optional<Long> ➖ Number of results to return. Minimum 1, Maximum 200, Default 20

Response

VaultConsumersAllResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/UnprocessableResponse 422 application/json
models/errors/APIException 4XX, 5XX */*

get

Consumer detail including their aggregated counts with the connections they have authorized.

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.VaultConsumersOneResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        VaultConsumersOneResponse res = sdk.vault().consumers().get()
                .consumerId("test_user_id")
                .call();

        if (res.getConsumerResponse().isPresent()) {
            System.out.println(res.getConsumerResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
consumerId String ✔️ ID of the consumer to return test_user_id

Response

VaultConsumersOneResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/UnprocessableResponse 422 application/json
models/errors/APIException 4XX, 5XX */*

update

Update consumer metadata such as name and email.

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.components.ConsumerMetadata;
import com.apideck.unify.models.components.UpdateConsumerRequest;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.VaultConsumersUpdateResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        VaultConsumersUpdateResponse res = sdk.vault().consumers().update()
                .consumerId("test_user_id")
                .updateConsumerRequest(UpdateConsumerRequest.builder()
                    .metadata(ConsumerMetadata.builder()
                        .accountName("SpaceX")
                        .userName("Elon Musk")
                        .email("elon@musk.com")
                        .image("https://www.spacex.com/static/images/share.jpg")
                        .build())
                    .build())
                .call();

        if (res.updateConsumerResponse().isPresent()) {
            System.out.println(res.updateConsumerResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
consumerId String ✔️ ID of the consumer to return test_user_id
updateConsumerRequest UpdateConsumerRequest ✔️ N/A

Response

VaultConsumersUpdateResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/UnprocessableResponse 422 application/json
models/errors/APIException 4XX, 5XX */*

delete

Delete consumer and all their connections, including credentials.

Example Usage

package hello.world;

import com.apideck.unify.Apideck;
import com.apideck.unify.models.errors.*;
import com.apideck.unify.models.operations.VaultConsumersDeleteResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws BadRequestResponse, UnauthorizedResponse, PaymentRequiredResponse, NotFoundResponse, UnprocessableResponse, Exception {

        Apideck sdk = Apideck.builder()
                .appId("dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX")
                .apiKey(System.getenv().getOrDefault("API_KEY", ""))
            .build();

        VaultConsumersDeleteResponse res = sdk.vault().consumers().delete()
                .consumerId("test_user_id")
                .call();

        if (res.deleteConsumerResponse().isPresent()) {
            System.out.println(res.deleteConsumerResponse().get());
        }
    }
}

Parameters

Parameter Type Required Description Example
appId Optional<String> ➖ The ID of your Unify application dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX
consumerId String ✔️ ID of the consumer to return test_user_id

Response

VaultConsumersDeleteResponse

Errors

Error Type Status Code Content Type
models/errors/BadRequestResponse 400 application/json
models/errors/UnauthorizedResponse 401 application/json
models/errors/PaymentRequiredResponse 402 application/json
models/errors/NotFoundResponse 404 application/json
models/errors/UnprocessableResponse 422 application/json
models/errors/APIException 4XX, 5XX */*