v1

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 version v1.12.5-0.20230118012357-f4cf8f9a5703 DO NOT EDIT.

Index

• func GetSwagger() (swagger *openapi3.T, err error)
• func PathToRawSpec(pathToFile string) map[string]func() ([]byte, error)
• type CreateIssuer
• type CreateIssuerJSONRequestBody
• type CreateOAuthClient
• type CreateOAuthClientJSONRequestBody
• type DeleteResponse
• type ErrorResponse
• type Issuer
• type IssuerUpdate
• type OAuthClient
• type UpdateIssuerJSONRequestBody

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

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

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 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 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 OAuthClient

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 UpdateIssuerJSONRequestBody

type UpdateIssuerJSONRequestBody = IssuerUpdate

UpdateIssuerJSONRequestBody defines body for UpdateIssuer for application/json ContentType.