v1

package
v0.1.20 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 13, 2024 License: Apache-2.0 Imports: 10 Imported by: 0

Documentation

Overview

Package v1 contains top-level types and functions for identity-api.

Package v1 provides primitives to interact with the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen/v2 version v2.1.0 DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetSwagger 

func GetSwagger() (swagger *openapi3.T, err error)

GetSwagger returns the Swagger specification corresponding to the generated code in this file. The external references of Swagger specification are resolved. The logic of resolving external references is tightly connected to "import-mapping" feature. Externally referenced files must be embedded in the corresponding golang packages. Urls can be supported but this task was out of the scope.

func PathToRawSpec 

func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)

Constructs a synthetic filesystem for resolving external references when loading openapi specifications.

Types

type CreateIssuer 

type CreateIssuer struct {
	// ClaimMappings CEL expressions mapping token claims to other claims
	ClaimMappings *map[string]string `json:"claim_mappings,omitempty"`

	// JwksUri JWKS URI
	JWKSURI string `json:"jwks_uri"`

	// Name A human-readable name for the issuer
	Name string `json:"name"`

	// Uri URI for the issuer. Must match the "iss" claim value in incoming JWTs
	URI string `json:"uri"`
}

CreateIssuer defines model for CreateIssuer.

type CreateIssuerJSONRequestBody 

type CreateIssuerJSONRequestBody = CreateIssuer

CreateIssuerJSONRequestBody defines body for CreateIssuer for application/json ContentType.

type CreateOAuthClient added in v0.0.8 

type CreateOAuthClient struct {
	// Audience Audiences that this client can request
	Audience *[]string `json:"audience,omitempty"`

	// Name A human-readable name for the client
	Name string `json:"name"`
}

CreateOAuthClient defines model for CreateOAuthClient.

type CreateOAuthClientJSONRequestBody added in v0.0.8 

type CreateOAuthClientJSONRequestBody = CreateOAuthClient

CreateOAuthClientJSONRequestBody defines body for CreateOAuthClient for application/json ContentType.

type DeleteResponse 

type DeleteResponse struct {
	// Success Always true.
	Success bool `json:"success"`
}

DeleteResponse defines model for DeleteResponse.

type ErrorResponse 

type ErrorResponse struct {
	Errors []string `json:"errors"`
}

ErrorResponse represents a generic error response.

type GetIssuerUsersParams added in v0.1.20 

type GetIssuerUsersParams struct {
	// Cursor the cursor to the results to return
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty" query:"cursor"`

	// Limit limits the response collections
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty" query:"limit"`
}

GetIssuerUsersParams defines parameters for GetIssuerUsers.

func (GetIssuerUsersParams) GetCursor added in v0.1.20 

func (p GetIssuerUsersParams) GetCursor() *crdbx.Cursor

GetCursor implements crdbx.Paginator returning the cursor.

func (GetIssuerUsersParams) GetLimit added in v0.1.20 

func (p GetIssuerUsersParams) GetLimit() int

GetLimit implements crdbx.Paginator returning requested limit.

func (GetIssuerUsersParams) GetOnlyFields added in v0.1.20 

func (p GetIssuerUsersParams) GetOnlyFields() []string

GetOnlyFields implements crdbx.Paginator setting the only permitted field to `id`.

func (GetIssuerUsersParams) SetPagination added in v0.1.20 

func (p GetIssuerUsersParams) SetPagination(collection *UserCollection) error

SetPagination sets the pagination on the provided collection.

type GetOwnerOAuthClientsParams added in v0.1.20 

type GetOwnerOAuthClientsParams struct {
	// Cursor the cursor to the results to return
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty" query:"cursor"`

	// Limit limits the response collections
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty" query:"limit"`
}

GetOwnerOAuthClientsParams defines parameters for GetOwnerOAuthClients.

func (GetOwnerOAuthClientsParams) GetCursor added in v0.1.20 

func (p GetOwnerOAuthClientsParams) GetCursor() *crdbx.Cursor

GetCursor implements crdbx.Paginator returning the cursor.

func (GetOwnerOAuthClientsParams) GetLimit added in v0.1.20 

func (p GetOwnerOAuthClientsParams) GetLimit() int

GetLimit implements crdbx.Paginator returning requested limit.

func (GetOwnerOAuthClientsParams) GetOnlyFields added in v0.1.20 

func (p GetOwnerOAuthClientsParams) GetOnlyFields() []string

GetOnlyFields implements crdbx.Paginator setting the only permitted field to `id`.

func (GetOwnerOAuthClientsParams) SetPagination added in v0.1.20 

func (p GetOwnerOAuthClientsParams) SetPagination(collection *OAuthClientCollection) error

SetPagination sets the pagination on the provided collection.

type Issuer 

type Issuer struct {
	// ClaimMappings CEL expressions mapping token claims to other claims
	ClaimMappings map[string]string `json:"claim_mappings"`

	// Id ID of the issuer
	ID gidx.PrefixedID `json:"id"`

	// JwksUri JWKS URI
	JWKSURI string `json:"jwks_uri"`

	// Name A human-readable name for the issuer
	Name string `json:"name"`

	// Uri URI for the issuer. Must match the "iss" claim value in incoming JWTs
	URI string `json:"uri"`
}

Issuer defines model for Issuer.

type IssuerCollection added in v0.1.20 

type IssuerCollection struct {
	Issuers []Issuer `json:"issuers"`

	// Pagination collection response pagination
	Pagination Pagination `json:"pagination"`
}

IssuerCollection defines model for IssuerCollection.

type IssuerID added in v0.1.20 

type IssuerID = gidx.PrefixedID

IssuerID defines model for issuerID.

type IssuerUpdate 

type IssuerUpdate struct {
	// ClaimMappings CEL expressions mapping token claims to other claims
	ClaimMappings *map[string]string `json:"claim_mappings,omitempty"`

	// JwksUri JWKS URI
	JWKSURI *string `json:"jwks_uri,omitempty"`

	// Name A human-readable name for the issuer
	Name *string `json:"name,omitempty"`

	// Uri URI for the issuer. Must match the "iss" claim value in incoming JWTs
	URI *string `json:"uri,omitempty"`
}

IssuerUpdate defines model for IssuerUpdate.

type ListOwnerIssuersParams added in v0.1.20 

type ListOwnerIssuersParams struct {
	// Cursor the cursor to the results to return
	Cursor *PageCursor `form:"cursor,omitempty" json:"cursor,omitempty" query:"cursor"`

	// Limit limits the response collections
	Limit *PageLimit `form:"limit,omitempty" json:"limit,omitempty" query:"limit"`
}

ListOwnerIssuersParams defines parameters for ListOwnerIssuers.

func (ListOwnerIssuersParams) GetCursor added in v0.1.20 

func (p ListOwnerIssuersParams) GetCursor() *crdbx.Cursor

GetCursor implements crdbx.Paginator returning the cursor.

func (ListOwnerIssuersParams) GetLimit added in v0.1.20 

func (p ListOwnerIssuersParams) GetLimit() int

GetLimit implements crdbx.Paginator returning requested limit.

func (ListOwnerIssuersParams) GetOnlyFields added in v0.1.20 

func (p ListOwnerIssuersParams) GetOnlyFields() []string

GetOnlyFields implements crdbx.Paginator setting the only permitted field to `id`.

func (ListOwnerIssuersParams) SetPagination added in v0.1.20 

func (p ListOwnerIssuersParams) SetPagination(collection *IssuerCollection) error

SetPagination sets the pagination on the provided collection.

type OAuthClient added in v0.0.8 

type OAuthClient struct {
	// Audience Grantable audiences
	Audience []string `json:"audience"`

	// Id OAuth 2.0 Client ID
	ID gidx.PrefixedID `json:"id"`

	// Name Description of Client
	Name string `json:"name"`

	// Secret OAuth2.0 Client Secret
	Secret *string `json:"secret,omitempty"`
}

OAuthClient defines model for OAuthClient.

type OAuthClientCollection added in v0.1.20 

type OAuthClientCollection struct {
	Clients []OAuthClient `json:"clients"`

	// Pagination collection response pagination
	Pagination Pagination `json:"pagination"`
}

OAuthClientCollection defines model for OAuthClientCollection.

type OwnerID added in v0.1.20 

type OwnerID = gidx.PrefixedID

OwnerID defines model for ownerID.

type PageCursor added in v0.1.20 

type PageCursor = crdbx.Cursor

PageCursor defines model for pageCursor.

type PageLimit added in v0.1.20 

type PageLimit = int

PageLimit defines model for pageLimit.

type Pagination added in v0.1.20 

type Pagination struct {
	// Limit the limit used for the collection response
	Limit int `json:"limit"`

	// Next the cursor for the next page
	Next *crdbx.Cursor `json:"next,omitempty"`
}

Pagination collection response pagination

type UpdateIssuerJSONRequestBody 

type UpdateIssuerJSONRequestBody = IssuerUpdate

UpdateIssuerJSONRequestBody defines body for UpdateIssuer for application/json ContentType.

type User added in v0.1.17 

type User struct {
	// Email Email of the user
	Email *string `json:"email,omitempty"`

	// Id OAuth 2.0 User ID
	ID gidx.PrefixedID `json:"id"`

	// Iss OAuth 2.0 Issuer of the user
	Issuer string `json:"iss"`

	// Name Name of the user
	Name *string `json:"name,omitempty"`

	// Sub OAuth 2.0 Subject for the user
	Subject string `json:"sub"`
}

User defines model for User.

type UserCollection added in v0.1.20 

type UserCollection struct {
	// Pagination collection response pagination
	Pagination Pagination `json:"pagination"`
	Users      []User     `json:"users"`
}

UserCollection defines model for UserCollection.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.