am

Documentation

Index

• Variables
• func CreateAgent(realm, agentName, payloadPath string) (err error)
• func CreateRealm(parentPath, realmName string, aliases ...string) (realmId string, err error)
• func CreateScript(realm string, config io.Reader) (err error)
• func CreateSecretMapping(secretID string, aliases []string) (err error)
• func CreateService(realm, serviceType string, config io.Reader) (err error)
• func CreateTree(realm, id string, config io.Reader) (err error)
• func CreateTreeNode(realm, nodeType, id string, config io.Reader) (err error)
• func DeleteAgent(realm string, agentName string) (err error)
• func DeleteIdentity() (err error)
• func DeleteRealm(realmId string) (err error)
• func DeleteScript(realm string, id string) (err error)
• func DeleteService(realm string, serviceName string) (err error)
• func DeleteTree(realm, id string) (err error)
• func DeleteTreeNode(realm, nodeType, id string) (err error)
• func GetAdvancedServerProperties() (properties map[string]interface{}, err error)
• func GetIdentity(realm, name string) ([]byte, error)
• func GetService(realm, name string) (response []byte, err error)
• func LogoutSession(token string) (err error)
• func OAuthBaseURL(amURL string, realmPath string, dnsConfigured bool) string
• func RevokeAccessToken(realm string, clientName string, clientPassword string, token string) error
• func SendUserConsent(realm string, user IdAttributes, userCode thing.DeviceAuthorizationResponse, ...) error
• func SetAdvancedServerProperties(properties map[string]interface{}) (err error)
• func URL(subDomain string) string
• func UpdateAgent(realm, agentName, payloadPath string) (err error)
• func UpdateRealm(properties RealmProperties) (err error)
• func UpdateService(realm, name string, payload io.Reader) (response []byte, err error)
• func ValidateSession(token string) (valid bool, err error)
• type IdAttributes
  • func CreateIdentity(realm string, attributes IdAttributes) (IdAttributes, error)
  • func (id IdAttributes) String() string
• type RealmProperties
  • func GetRealm(fullName string) (properties RealmProperties, err error)

Variables

var AMURL = URL("am")

Base AM URL

var AdminPassword = "password"

AM admin's password

var DebugLogger = log.New(io.Discard, "", 0)

Functions

func CreateAgent

func CreateAgent(realm, agentName, payloadPath string) (err error)

CreateAgent creates an agent (OAuth 2.0 Client, JWT Issuer etc) in the realm

func CreateRealm

func CreateRealm(parentPath, realmName string, aliases ...string) (realmId string, err error)

CreateRealm creates a realm with the given name Returns the realm Id that is required to modify/delete the realm

func CreateScript

func CreateScript(realm string, config io.Reader) (err error)

CreateScript creates the script in the realm

func CreateSecretMapping

func CreateSecretMapping(secretID string, aliases []string) (err error)

CreateSecretMapping creates or updates the secret mapping in the default keystore

func CreateService

func CreateService(realm, serviceType string, config io.Reader) (err error)

CreateService creates a service in the realm

func CreateTree

func CreateTree(realm, id string, config io.Reader) (err error)

CreateTree creates an auth tree in the realm

func CreateTreeNode

func CreateTreeNode(realm, nodeType, id string, config io.Reader) (err error)

CreateTreeNode creates an auth tree node in the realm

func DeleteAgent

func DeleteAgent(realm string, agentName string) (err error)

DeleteAgent deletes the agent from the realm

func DeleteIdentity

func DeleteIdentity() (err error)

DeleteIdentity deletes the identity from AM

func DeleteRealm

func DeleteRealm(realmId string) (err error)

DeleteRealm deletes the realm with the given Id

func DeleteScript

func DeleteScript(realm string, id string) (err error)

DeleteScript deletes the script from the realm

func DeleteService

func DeleteService(realm string, serviceName string) (err error)

DeleteService deletes the service from the realm

func DeleteTree

func DeleteTree(realm, id string) (err error)

DeleteTree deletes the auth tree from the realm

func DeleteTreeNode

func DeleteTreeNode(realm, nodeType, id string) (err error)

DeleteTreeNode deletes the auth tree node from the realm

func GetAdvancedServerProperties

func GetAdvancedServerProperties() (properties map[string]interface{}, err error)

func GetIdentity

func GetIdentity(realm, name string) ([]byte, error)

GetIdentity gets the identity from AM

func GetService

func GetService(realm, name string) (response []byte, err error)

GetService returns the realm configuration of the given service

func LogoutSession

func LogoutSession(token string) (err error)

LogoutSession represented by the given token

func OAuthBaseURL

func OAuthBaseURL(amURL string, realmPath string, dnsConfigured bool) string

OAuthBaseURL constructs the OAuth base URL that can be used as the audience for OAuth based requests

func RevokeAccessToken

func RevokeAccessToken(realm string, clientName string, clientPassword string, token string) error

RevokeAccessToken calls AM to revoke the access token

func SendUserConsent

func SendUserConsent(realm string, user IdAttributes, userCode thing.DeviceAuthorizationResponse, decision string) error

SendUserConsent will send the decision to allow or deny a device authorization grant request.

func SetAdvancedServerProperties

func SetAdvancedServerProperties(properties map[string]interface{}) (err error)

func URL

func URL(subDomain string) string

func UpdateAgent

func UpdateAgent(realm, agentName, payloadPath string) (err error)

UpdateAgent updates an agent's (OAuth 2.0 Client, JWT Issuer etc) configuration in AM

func UpdateRealm

func UpdateRealm(properties RealmProperties) (err error)

UpdateRealm updates the realm with the given properties

func UpdateService

func UpdateService(realm, name string, payload io.Reader) (response []byte, err error)

UpdateService updates the realm configuration of the given service

func ValidateSession

func ValidateSession(token string) (valid bool, err error)

ValidateSession will validate the session represented by the given token

Types

type IdAttributes

type IdAttributes struct {
	Name                  string             `json:"username"`
	ID                    string             `json:"_id,omitempty"`
	Password              string             `json:"userPassword,omitempty"`
	ThingType             callback.ThingType `json:"thingType,omitempty"`
	ThingKeys             jose.JSONWebKeySet `json:"thingKeys,omitempty"`
	ThingOAuth2ClientName string             `json:"thingOAuth2ClientName,omitempty"`
	ThingConfig           string             `json:"thingConfig,omitempty"`
}

IdAttributes contains identity attributes

func CreateIdentity

func CreateIdentity(realm string, attributes IdAttributes) (IdAttributes, error)

CreateIdentity creates an identity in the the given realm using the supplied attributes

func (IdAttributes) String

func (id IdAttributes) String() string

type RealmProperties

type RealmProperties struct {
	ID         string   `json:"_id,omitempty"`
	Name       string   `json:"name"`
	Active     bool     `json:"active"`
	ParentPath string   `json:"parentPath"`
	Aliases    []string `json:"aliases"`
}

func GetRealm

func GetRealm(fullName string) (properties RealmProperties, err error)

GetRealm searches for te realm with the given name