authorization

Documentation

Overview

* BSD 3-Clause License * Copyright © 2020. TIBCO Software Inc. * This file is subject to the license terms contained * in the license file that is distributed with this file.

* BSD 3-Clause License * Copyright © 2020. TIBCO Software Inc. * This file is subject to the license terms contained * in the license file that is distributed with this file.

Index

• Constants
• func GetClaims(region string, authentication interface{}) (statusCode int, responseOK Claims, responseKO Error, err error)
• type Claims
• type ClaimsGroup
• type ClaimsSandbox
• type ClaimsValues
• type Error
• type ErrorAttribute
• type Group
• type GroupDetails
• type Parameter
• type Sandbox
• type SandboxContent
• type User
• type UserDetails
• type UserGroupMapping
• type UserGroupMappingContent

Constants

const (
	AuthorizationV1 = "/organisation/v1"
	GROUPS          = "/groups"
	MAPPINGS        = "/userGroupMappings"
)

const (
	CLAIMS = "/claims"
)

CLAIMS endpoint

Functions

func GetClaims

func GetClaims(region string, authentication interface{}) (statusCode int, responseOK Claims, responseKO Error, err error)

GetClaims Returns the details for each User in the current subscription whose name matches the specified query parameters.

Types

type Claims

type Claims struct {
	SubscriptionID string          `json:"subscriptionId"` // The subscription to which this User belongs
	FirstName      string          `json:"firstName"`      // First name of the User
	LastName       string          `json:"lastName"`       // Last name of the User
	Username       string          `json:"username"`       // Username of the User
	Email          string          `json:"email"`          // email address of the User
	Status         []string        `json:"status"`         // An array of status values applicable to this User. Valid values are 'VerifyEmailOutstanding’.
	Sandboxes      []ClaimsSandbox `json:"sandboxes"`      // The Sandboxes to which the User has access
	ID             string          `json:"id"`             // The unique identifier for a User
}

Claims Details supplied for the Claims

type ClaimsGroup

type ClaimsGroup struct {
	ID   string `json:"id"`
	Type string `json:"type"` // The type of Group: AllUsers, Administrator, ApplicationDeveloper, UIDeveloper, SubscriptionDefined
}

ClaimsGroup The Group details needed by the Claims

type ClaimsSandbox

type ClaimsSandbox struct {
	ID     string        `json:"id"`
	Type   string        `json:"type"`   // The type of Sandbox: Production, Developer
	Groups []ClaimsGroup `json:"groups"` // The Groups to which the user with this Sandbox has access
}

ClaimsSandbox The Sandbox details needed by the Claims

type ClaimsValues

type ClaimsValues struct {
	SubscriptionID string          `json:"subscriptionId"` // The subscription to which this User belongs
	FirstName      string          `json:"firstName"`      // First name of the User
	LastName       string          `json:"lastName"`       // Last name of the User
	Username       string          `json:"username"`       // Username of the User
	Email          string          `json:"email"`          // email address of the User
	Status         []string        `json:"status"`         // An array of status values applicable to this User. Valid values are 'VerifyEmailOutstanding’.
	Sandboxes      []ClaimsSandbox `json:"sandboxes"`      // The Sandboxes to which the User has access
}

ClaimsValues Details supplied for the Claims

type Error

type Error struct {
	ErrorMsg         string           `json:"errorMsg"`          // Verbose error message
	ErrorCode        string           `json:"errorCode"`         // Possible error codes in the Authorization Engine Service
	StackTrace       string           `json:"stackTrace"`        // Added if available
	ContextAttribute []ErrorAttribute `json:"contextAttributes"` // Error Attributes
}

Error Error

type ErrorAttribute

type ErrorAttribute struct {
	Name  string `json:"name"`  // Name of the error attrubute
	Value string `json:"value"` // Value of the error attribute
}

ErrorAttribute A given error attribute

type Group

type Group struct {
	Name        string `json:"name"`        // Name of the Group
	Description string `json:"description"` // Description of the Group
	Type        string `json:"type"`        // The type of Group (SubscriptionDefined if not set): AllUsers, Administrator, ApplicationDeveloper, UIDeveloper, SubscriptionDefined
	ID          string `json:"id"`          // The unique identifier for a Group.
}

Group Complete details for a Group, including the unique id

type GroupDetails

type GroupDetails struct {
	Name        string `json:"name"`        // Name of the Group
	Description string `json:"description"` // Description of the Group
	Type        string `json:"type"`        // The type of Group (SubscriptionDefined if not set): AllUsers, Administrator, ApplicationDeveloper, UIDeveloper, SubscriptionDefined
}

GroupDetails The required details for a given Group

type Parameter

type Parameter struct {
	Name  string `json:"name"`  // The name of the Parameter (case insensitive)
	Value string `json:"value"` // The value of the Parameter
}

Parameter A Parameter for a subscription, as a name-value pair

type Sandbox

type Sandbox struct {
	Name           string `json:"name"`           // Name of the Sandbox
	Type           string `json:"type"`           // The type of Sandbox: Production, Developer
	SubscriptionID string `json:"subscriptionId"` // The subscription to which this Sandbox belongs
	OwnerID        string `json:"ownerId"`        // The id of the User that owns the Sandbox
	ID             string `json:"id"`             // The unique identifier for a Sandbox
}

Sandbox Complete details for a Sandbox, including its unique ID

type SandboxContent

type SandboxContent struct {
	Name           string `json:"name"`           // Name of the Sandbox
	Type           string `json:"type"`           // The type of Sandbox: Production, Developer
	SubscriptionID string `json:"subscriptionId"` // The subscription to which this Sandbox belongs
	OwnerID        string `json:"ownerId"`        // The id of the User that owns the Sandbox
}

SandboxContent The required details for a Sandbox

type User

type User struct {
	ExternalID  string `json:"externalId"`  // The external identifier for the User. Note: In general, use the unique identifier (‘id’) when specifying a User. Do not use the externalId value unless specifically requested to do so.
	FirstName   string `json:"firstName"`   // First name of the User
	LastName    string `json:"lastName"`    // Last name of the User
	Username    string `json:"username"`    // Username of the User
	Email       string `json:"email"`       // email address of the User
	ReportsTo   string `json:"reportsTo"`   // The display name of the person this user reports to
	JobTitle    string `json:"jobTitle"`    // The job title of the user
	Description string `json:"description"` // A text description of the user
	Department  string `json:"department"`  // The name of the department the user is in
	Type        string `json:"type"`        // Type of the user. (Test users cannot be created.)
	ID          string `json:"id"`          // The unique identifier for a User
}

User The complete details for a User, including their unique id

type UserDetails

type UserDetails struct {
	ExternalID  string `json:"externalId"`  // The external identifier for the User. Note: In general, use the unique identifier (‘id’) when specifying a User. Do not use the externalId value unless specifically requested to do so.
	FirstName   string `json:"firstName"`   // First name of the User
	LastName    string `json:"lastName"`    // Last name of the User
	Username    string `json:"username"`    // Username of the User
	Email       string `json:"email"`       // email address of the User
	ReportsTo   string `json:"reportsTo"`   // The display name of the person this user reports to
	JobTitle    string `json:"jobTitle"`    // The job title of the user
	Description string `json:"description"` // A text description of the user
	Department  string `json:"Department"`  // The name of the department the user is in
	Type        string `json:"type"`        // Type of the user. (Test users cannot be created.)
}

UserDetails The details for a User, excluding their id

type UserGroupMapping

type UserGroupMapping struct {
	SandboxID string `json:"sandboxId"` // The id of the Sandbox which the mapping is for
	GroupID   string `json:"groupId"`   // The id of the Group
	UserID    string `json:"userId"`    // The id of the User
	ID        string `json:"id"`        // The unique identifier for a UserGroupMapping
}

UserGroupMapping Complete details for a UserGroupMapping, including its unique id

type UserGroupMappingContent

type UserGroupMappingContent struct {
	SandboxID string `json:"sandboxId"` // The id of the Sandbox which the mapping is for
	GroupID   string `json:"groupId"`   // The id of the Group
	UserID    string `json:"userId"`    // The id of the User
}

UserGroupMappingContent The required details for a UserGroupMapping