Skip to content

Latest commit

 

History

History
419 lines (280 loc) · 14.7 KB

README.md

File metadata and controls

419 lines (280 loc) · 14.7 KB

V1

(Auth.V1)

Overview

Available Operations

GetOIDCWellKnowns

Retrieve OpenID connect well-knowns.

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.GetOIDCWellKnownsAsync();

// handle response

Response

GetOIDCWellKnownsResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

GetServerInfo

Get server info

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.GetServerInfoAsync();

// handle response

Response

GetServerInfoResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

ListClients

List clients

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.ListClientsAsync();

// handle response

Response

Models.Requests.ListClientsResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

CreateClient

Create client

Example Usage

using formance;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

CreateClientRequest req = new CreateClientRequest() {
    Name = "<value>",
};

var res = await sdk.Auth.V1.CreateClientAsync(req);

// handle response

Parameters

Parameter Type Required Description
request CreateClientRequest ✔️ The request object to use for the request.

Response

Models.Requests.CreateClientResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

ReadClient

Read client

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.ReadClientAsync(clientId: "<id>");

// handle response

Parameters

Parameter Type Required Description
ClientId string ✔️ Client ID

Response

Models.Requests.ReadClientResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

UpdateClient

Update client

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.UpdateClientAsync(
    clientId: "<id>",
    updateClientRequest: new Models.Components.UpdateClientRequest() {
        Name = "<value>",
    }
);

// handle response

Parameters

Parameter Type Required Description
ClientId string ✔️ Client ID
UpdateClientRequest Models.Components.UpdateClientRequest ➖ N/A

Response

Models.Requests.UpdateClientResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

DeleteClient

Delete client

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.DeleteClientAsync(clientId: "<id>");

// handle response

Parameters

Parameter Type Required Description
ClientId string ✔️ Client ID

Response

DeleteClientResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

CreateSecret

Add a secret to a client

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;
using System.Collections.Generic;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.CreateSecretAsync(
    clientId: "<id>",
    createSecretRequest: new Models.Components.CreateSecretRequest() {
        Name = "<value>",
    }
);

// handle response

Parameters

Parameter Type Required Description
ClientId string ✔️ Client ID
CreateSecretRequest Models.Components.CreateSecretRequest ➖ N/A

Response

Models.Requests.CreateSecretResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

DeleteSecret

Delete a secret from a client

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.DeleteSecretAsync(
    clientId: "<id>",
    secretId: "<id>"
);

// handle response

Parameters

Parameter Type Required Description
ClientId string ✔️ Client ID
SecretId string ✔️ Secret ID

Response

DeleteSecretResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

ListUsers

List users

Example Usage

using formance;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.ListUsersAsync();

// handle response

Response

Models.Requests.ListUsersResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*

ReadUser

Read user

Example Usage

using formance;
using formance.Models.Requests;
using formance.Models.Components;

var sdk = new Formance(security: new Security() {
    ClientID = "<YOUR_CLIENT_ID_HERE>",
    ClientSecret = "<YOUR_CLIENT_SECRET_HERE>",
});

var res = await sdk.Auth.V1.ReadUserAsync(userId: "<id>");

// handle response

Parameters

Parameter Type Required Description
UserId string ✔️ User ID

Response

Models.Requests.ReadUserResponse

Errors

Error Type Status Code Content Type
formance.Models.Errors.SDKException 4XX, 5XX */*