Permissions

(Permissions)

Overview

Available Operations

CreatePermission
DeletePermission
GetPermission
ListPermissions
CreateRole
DeleteRole
GetRole
ListRoles

CreatePermission

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.CreatePermission(ctx, operations.CreatePermissionRequestBody{
        Name: "record.write",
        Description: unkeygo.String("record.write can create new dns records for our domains."),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.CreatePermissionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

DeletePermission

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.DeletePermission(ctx, operations.DeletePermissionRequestBody{
        PermissionID: "perm_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.DeletePermissionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetPermission

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.GetPermission(ctx, operations.GetPermissionRequest{
        PermissionID: "perm_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetPermissionResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

ListPermissions

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.ListPermissions(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ResponseBodies != 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.ListPermissionsResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

CreateRole

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.CreateRole(ctx, operations.CreateRoleRequestBody{
        Name: "dns.records.manager",
        Description: unkeygo.String("dns.records.manager can read and write dns records for our domains."),
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.CreateRoleResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

DeleteRole

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.DeleteRole(ctx, operations.DeleteRoleRequestBody{
        RoleID: "role_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.DeleteRoleResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

GetRole

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"github.com/unkeyed/unkey-go/models/operations"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.GetRole(ctx, operations.GetRoleRequest{
        RoleID: "role_123",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.Object != nil {
        // handle response
    }
}

Parameters

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

Response

*operations.GetRoleResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

ListRoles

Example Usage

package main

import(
	"context"
	unkeygo "github.com/unkeyed/unkey-go"
	"log"
)

func main() {
    ctx := context.Background()
    
    s := unkeygo.New(
        unkeygo.WithSecurity("UNKEY_ROOT_KEY"),
    )

    res, err := s.Permissions.ListRoles(ctx)
    if err != nil {
        log.Fatal(err)
    }
    if res.ResponseBodies != 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.ListRolesResponse, error

Errors

Error Type	Status Code	Content Type
sdkerrors.ErrBadRequest	400	application/json
sdkerrors.ErrUnauthorized	401	application/json
sdkerrors.ErrForbidden	403	application/json
sdkerrors.ErrNotFound	404	application/json
sdkerrors.ErrConflict	409	application/json
sdkerrors.ErrTooManyRequests	429	application/json
sdkerrors.ErrInternalServerError	500	application/json
sdkerrors.SDKError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Permissions

Overview

Available Operations

CreatePermission

Example Usage

Parameters

Response

Errors

DeletePermission

Example Usage

Parameters

Response

Errors

GetPermission

Example Usage

Parameters

Response

Errors

ListPermissions

Example Usage

Parameters

Response

Errors

CreateRole

Example Usage

Parameters

Response

Errors

DeleteRole

Example Usage

Parameters

Response

Errors

GetRole

Example Usage

Parameters

Response

Errors

ListRoles

Example Usage

Parameters

Response

Errors