datadogconnector

Documentation

Index

• func AddResourceUser(c *gin.Context)
• func GenerateSignature(signingSecret string, timestamp string, serializedBlob []byte) (string, error)
• func GetDatadogClient() *datadog.APIClient
• func GetResource(c *gin.Context)
• func GetResourceAccessLevels(c *gin.Context)
• func GetResourceUsers(c *gin.Context)
• func GetResources(c *gin.Context)
• func GetStatus(c *gin.Context)
• func GetUsers(c *gin.Context)
• func NewRouter() *gin.Engine
• func RemoveResourceUser(c *gin.Context)
• type AccessLevel
• type AddResourceUserRequest
• type Cursor
• type Error
• type Resource
• type ResourceAccessLevelsResponse
• type ResourceResponse
• type ResourceUser
• type ResourceUsersResponse
• type ResourcesResponse
• type Route
• type Routes
• type User
• type UsersResponse

Functions

func AddResourceUser

func AddResourceUser(c *gin.Context)

AddResourceUser -

func GenerateSignature

func GenerateSignature(
	signingSecret string,
	timestamp string,
	serializedBlob []byte,
) (string, error)

GenerateSignature generates a signature for a given payload in a HTTP request

func GetDatadogClient

func GetDatadogClient() *datadog.APIClient

func GetResource

func GetResource(c *gin.Context)

GetResource -

func GetResourceAccessLevels

func GetResourceAccessLevels(c *gin.Context)

GetResourceAccessLevels -

func GetResourceUsers

func GetResourceUsers(c *gin.Context)

GetResourceUsers -

func GetResources

func GetResources(c *gin.Context)

GetResources -

func GetStatus

func GetStatus(c *gin.Context)

GetStatus -

func GetUsers

func GetUsers(c *gin.Context)

GetUsers -

func NewRouter

func NewRouter() *gin.Engine

NewRouter returns a new router.

func RemoveResourceUser

func RemoveResourceUser(c *gin.Context)

RemoveResourceUser -

Types

type AccessLevel

type AccessLevel struct {

	// The id of the access level in your system. Opal will provide this id when making requests for the access level to your connector.
	Id string `json:"id"`

	// The name of the access level
	Name string `json:"name"`
}

type AddResourceUserRequest

type AddResourceUserRequest struct {

	// The ID of the user to add.
	UserId string `json:"user_id"`

	// The identifier of your custom app.
	AppId string `json:"app_id"`

	// The ID of the access level to assign to the user.
	AccessLevelId string `json:"access_level_id,omitempty"`
}

type Cursor

type Cursor struct {
	NextPage int
}

Cursor is a struct that contains the next page number

type Error

type Error struct {
	Code int32 `json:"code"`

	Message string `json:"message"`
}

type Resource

type Resource struct {

	// The id of the resource in your system. Opal will provide this id when making requests for the resource to your connector.
	Id string `json:"id"`

	// The name of the resource
	Name string `json:"name"`

	// The description of the resource. If provided, it will be imported into Opal.
	Description string `json:"description,omitempty"`
}

type ResourceAccessLevelsResponse

type ResourceAccessLevelsResponse struct {

	// The cursor with which to continue pagination if additional result pages exist.
	NextCursor *string `json:"next_cursor,omitempty"`

	AccessLevels []AccessLevel `json:"access_levels"`
}

type ResourceResponse

type ResourceResponse struct {
	Resource Resource `json:"resource"`
}

type ResourceUser

type ResourceUser struct {

	// The id of the user in your system. Opal will provide this id when making requests for the user to your connector.
	UserId string `json:"user_id"`

	// The email of the user. Opal will use this to associate the user with the corresponding Opal user.
	Email string `json:"email,omitempty"`

	AccessLevel AccessLevel `json:"access_level,omitempty"`
}

type ResourceUsersResponse

type ResourceUsersResponse struct {

	// The cursor with which to continue pagination if additional result pages exist.
	NextCursor *string `json:"next_cursor,omitempty"`

	Users []ResourceUser `json:"users"`
}

type ResourcesResponse

type ResourcesResponse struct {

	// The cursor with which to continue pagination if additional result pages exist.
	NextCursor *string `json:"next_cursor,omitempty"`

	Resources []Resource `json:"resources"`
}

type Route

type Route struct {
	// Name is the name of this Route.
	Name string
	// Method is the string for the HTTP method. ex) GET, POST etc..
	Method string
	// Pattern is the pattern of the URI.
	Pattern string
	// HandlerFunc is the handler function of this route.
	HandlerFunc gin.HandlerFunc
}

Route is the information for every URI.

type Routes

type Routes []Route

Routes is the list of the generated Route.

type User

type User struct {

	// The id of the user in your system. Opal will provide this id when making requests for the user to your connector.
	Id string `json:"id"`

	// The email of the user. Opal will use this to associate the user with the corresponding Opal user.
	Email string `json:"email"`
}

type UsersResponse

type UsersResponse struct {

	// The cursor with which to continue pagination if additional result pages exist.
	NextCursor *string `json:"next_cursor,omitempty"`

	Users []User `json:"users"`
}