auth/pkg/client/docs/sdks/v1

V1

(Auth.V1)

Available Operations

• GetOIDCWellKnowns - Retrieve OpenID connect well-knowns.
• GetServerInfo - Get server info
• ListClients - List clients
• CreateClient - Create client
• ReadClient - Read client
• UpdateClient - Update client
• DeleteClient - Delete client
• CreateSecret - Add a secret to a client
• DeleteSecret - Delete a secret from a client
• ListUsers - List users
• ReadUser - Read user

GetOIDCWellKnowns

Retrieve OpenID connect well-knowns.

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )

    ctx := context.Background()
    res, err := s.Auth.V1.GetOIDCWellKnowns(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetOIDCWellKnownsResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

GetServerInfo

Get server info

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )

    ctx := context.Background()
    res, err := s.Auth.V1.GetServerInfo(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ServerInfo != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.GetServerInfoResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListClients

List clients

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )

    ctx := context.Background()
    res, err := s.Auth.V1.ListClients(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListClientsResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListClientsResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

CreateClient

Create client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )

    ctx := context.Background()
    res, err := s.Auth.V1.CreateClient(ctx, nil)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateClientResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	components.CreateClientRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.CreateClientResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ReadClient

Read client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.ReadClientRequest{
        ClientID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.ReadClient(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.ReadClientResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ReadClientRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ReadClientResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

UpdateClient

Update client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.UpdateClientRequest{
        ClientID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.UpdateClient(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.UpdateClientResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.UpdateClientRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.UpdateClientResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

DeleteClient

Delete client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.DeleteClientRequest{
        ClientID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.DeleteClient(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.DeleteClientRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteClientResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

CreateSecret

Add a secret to a client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.CreateSecretRequest{
        ClientID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.CreateSecret(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.CreateSecretResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.CreateSecretRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.CreateSecretResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

DeleteSecret

Delete a secret from a client

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.DeleteSecretRequest{
        ClientID: "<value>",
        SecretID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.DeleteSecret(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.DeleteSecretRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.DeleteSecretResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ListUsers

List users

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )

    ctx := context.Background()
    res, err := s.Auth.V1.ListUsers(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ListUsersResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ListUsersResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/

ReadUser

Read user

Example Usage

package main

import(
	"github.com/formancehq/auth/pkg/client/models/components"
	"github.com/formancehq/auth/pkg/client"
	"github.com/formancehq/auth/pkg/client/models/operations"
	"context"
	"log"
)

func main() {
    s := client.New(
        client.WithSecurity(components.Security{
            ClientID: "",
            ClientSecret: "",
        }),
    )
    request := operations.ReadUserRequest{
        UserID: "<value>",
    }
    ctx := context.Background()
    res, err := s.Auth.V1.ReadUser(ctx, request)
    if err != nil {
        log.Fatal(err)
    }
    if res.ReadUserResponse != nil {
        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
ctx	context.Context	✔️	The context to use for the request.
request	operations.ReadUserRequest	✔️	The request object to use for the request.
opts	[]operations.Option	➖	The options for this request.

Response

*operations.ReadUserResponse, error

Error Object	Status Code	Content Type
sdkerrors.SDKError	4xx-5xx	/