Auth

(auth())

Available Operations

createClient - Create client
createSecret - Add a secret to a client
deleteClient - Delete client
deleteSecret - Delete a secret from a client
listClients - List clients
listUsers - List users
readClient - Read client
readUser - Read user
updateClient - Update client

createClient

Create client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreateClientResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.CreateClientRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            CreateClientRequest req = CreateClientRequest.builder()
                .name("<value>")
                .description("Managed optimizing help-desk")
                .metadata(java.util.Map.ofEntries(
                    entry("key", "<value>")))
                .postLogoutRedirectUris(java.util.List.of(
                    "<value>"))
                .public_(false)
                .redirectUris(java.util.List.of(
                    "<value>"))
                .scopes(java.util.List.of(
                    "<value>"))
                .trusted(false)
                .build();

            CreateClientResponse res = sdk.auth().createClient()
                .request(req)
                .call();

            if (res.createClientResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.shared.CreateClientRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreateClientResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

createSecret

Add a secret to a client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.CreateSecretRequest;
import com.formance.formance_sdk.models.operations.CreateSecretResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.CreateSecretRequest;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            CreateSecretRequest req = CreateSecretRequest.builder()
                .clientId("<value>")
                .createSecretRequest(CreateSecretRequest.builder()
                    .name("<value>")
                    .metadata(java.util.Map.ofEntries(
                        entry("key", "<value>")))
                    .build())
                .build();

            CreateSecretResponse res = sdk.auth().createSecret()
                .request(req)
                .call();

            if (res.createSecretResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.CreateSecretRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.CreateSecretResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

deleteClient

Delete client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.DeleteClientRequest;
import com.formance.formance_sdk.models.operations.DeleteClientResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeleteClientRequest req = DeleteClientRequest.builder()
                .clientId("<value>")
                .build();

            DeleteClientResponse res = sdk.auth().deleteClient()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.DeleteClientRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeleteClientResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

deleteSecret

Delete a secret from a client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.DeleteSecretRequest;
import com.formance.formance_sdk.models.operations.DeleteSecretResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            DeleteSecretRequest req = DeleteSecretRequest.builder()
                .clientId("<value>")
                .secretId("<value>")
                .build();

            DeleteSecretResponse res = sdk.auth().deleteSecret()
                .request(req)
                .call();

            // handle response
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.DeleteSecretRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.DeleteSecretResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listClients

List clients

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListClientsResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListClientsResponse res = sdk.auth().listClients()
                .call();

            if (res.listClientsResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListClientsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

listUsers

List users

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ListUsersResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ListUsersResponse res = sdk.auth().listUsers()
                .call();

            if (res.listUsersResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Response

Optional<? extends com.formance.formance_sdk.models.operations.ListUsersResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

readClient

Read client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ReadClientRequest;
import com.formance.formance_sdk.models.operations.ReadClientResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ReadClientRequest req = ReadClientRequest.builder()
                .clientId("<value>")
                .build();

            ReadClientResponse res = sdk.auth().readClient()
                .request(req)
                .call();

            if (res.readClientResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.ReadClientRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ReadClientResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

readUser

Read user

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.ReadUserRequest;
import com.formance.formance_sdk.models.operations.ReadUserResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            ReadUserRequest req = ReadUserRequest.builder()
                .userId("<value>")
                .build();

            ReadUserResponse res = sdk.auth().readUser()
                .request(req)
                .call();

            if (res.readUserResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.ReadUserRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.ReadUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

updateClient

Update client

Example Usage

package hello.world;

import com.formance.formance_sdk.SDK;
import com.formance.formance_sdk.models.operations.*;
import com.formance.formance_sdk.models.operations.UpdateClientRequest;
import com.formance.formance_sdk.models.operations.UpdateClientResponse;
import com.formance.formance_sdk.models.shared.*;
import com.formance.formance_sdk.models.shared.Security;
import com.formance.formance_sdk.models.shared.UpdateClientRequest;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.time.LocalDate;
import java.time.OffsetDateTime;
import java.util.Optional;
import static java.util.Map.entry;

public class Application {

    public static void main(String[] args) {
        try {
            SDK sdk = SDK.builder()
                .security(Security.builder()
                    .authorization("<YOUR_AUTHORIZATION_HERE>")
                    .build())
                .build();

            UpdateClientRequest req = UpdateClientRequest.builder()
                .clientId("<value>")
                .updateClientRequest(UpdateClientRequest.builder()
                    .name("<value>")
                    .description("Secured static model")
                    .metadata(java.util.Map.ofEntries(
                        entry("key", "<value>")))
                    .postLogoutRedirectUris(java.util.List.of(
                        "<value>"))
                    .public_(false)
                    .redirectUris(java.util.List.of(
                        "<value>"))
                    .scopes(java.util.List.of(
                        "<value>"))
                    .trusted(false)
                    .build())
                .build();

            UpdateClientResponse res = sdk.auth().updateClient()
                .request(req)
                .call();

            if (res.updateClientResponse().isPresent()) {
                // handle response
            }
        } catch (com.formance.formance_sdk.models.errors.SDKError e) {
            // handle exception
        } catch (Exception e) {
            // handle exception
        }
    }
}

Parameters

Parameter	Type	Required	Description
`request`	com.formance.formance_sdk.models.operations.UpdateClientRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.formance.formance_sdk.models.operations.UpdateClientResponse>

Errors

Error Object	Status Code	Content Type
models/errors/SDKError	4xx-5xx	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Auth

Available Operations

createClient

Example Usage

Parameters

Response

Errors

createSecret

Example Usage

Parameters

Response

Errors

deleteClient

Example Usage

Parameters

Response

Errors

deleteSecret

Example Usage

Parameters

Response

Errors

listClients

Example Usage

Response

Errors

listUsers

Example Usage

Response

Errors

readClient

Example Usage

Parameters

Response

Errors

readUser

Example Usage

Parameters

Response

Errors

updateClient

Example Usage

Parameters

Response

Errors