authorizationmanagement

package
v2.39.1 Latest Latest
Warning

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

 Go to latest Published: Jul 1, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Overview

Code generated by tutone: DO NOT EDIT

Code generated by tutone: DO NOT EDIT

Index

Constants

View Source 
const AuthorizationManagementGrantAccessMutation = `` /* 250-byte string literal not displayed */
View Source 
const AuthorizationManagementRevokeAccessMutation = `` /* 255-byte string literal not displayed */

Variables

This section is empty.

Functions

This section is empty.

Types

type Actor 

type Actor struct {
	// The `organization` field is the entry point into data that is scoped to the user's organization.
	Organization Organization `json:"organization,omitempty"`
}

Actor - The `Actor` object contains fields that are scoped to the API user's access level.

type AuthorizationManagementAccountAccessGrant 

type AuthorizationManagementAccountAccessGrant struct {
	// The Account ID the Role will grant access to
	AccountID int `json:"accountId"`
	// The Role ID that will define the access
	RoleId string `json:"roleId"`
}

AuthorizationManagementAccountAccessGrant - The Account and Role a Group should have access to

type AuthorizationManagementGrantAccess 

type AuthorizationManagementGrantAccess struct {
	// The Role and the Account the Target Group should have access to
	AccountAccessGrants []AuthorizationManagementAccountAccessGrant `json:"accountAccessGrants,omitempty"`
	// The Role and the Group the Target Group should have access to
	GroupAccessGrants []AuthorizationManagementGroupAccessGrant `json:"groupAccessGrants,omitempty"`
	// The Group ID that will have access granted
	GroupId string `json:"groupId"`
	// The Role and the Organization the Target Group should have access to
	OrganizationAccessGrants []AuthorizationManagementOrganizationAccessGrant `json:"organizationAccessGrants,omitempty"`
}

AuthorizationManagementGrantAccess - The input object representing the access to grant for the group

type AuthorizationManagementGrantAccessPayload 

type AuthorizationManagementGrantAccessPayload struct {
	// the roles that were granted to this group
	Roles []AuthorizationManagementGrantedRole `json:"roles"`
}

AuthorizationManagementGrantAccessPayload - Autogenerated return type of GrantAccess

type AuthorizationManagementGrantAccessQueryResponse 

type AuthorizationManagementGrantAccessQueryResponse struct {
	AuthorizationManagementGrantAccessPayload AuthorizationManagementGrantAccessPayload `json:"AuthorizationManagementGrantAccess"`
}

type AuthorizationManagementGrantedRole 

type AuthorizationManagementGrantedRole struct {
	// the account that this role grants access to
	AccountID int `json:"accountId,omitempty"`
	// the name of the object
	DisplayName string `json:"displayName,omitempty"`
	// the group that this role grants access to
	GroupId string `json:"groupId,omitempty"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// the name of the object
	Name string `json:"name"`
	// the organization this role grants access to
	OrganizationId string `json:"organizationId,omitempty"`
	// the role that defines this access
	RoleId int `json:"roleId"`
	// the type of the role
	Type string `json:"type"`
}

AuthorizationManagementGrantedRole - A Granted Role represents the access given to a group.

type AuthorizationManagementGrantedRoleSearch 

type AuthorizationManagementGrantedRoleSearch struct {
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the roles granted to this group
	Roles []AuthorizationManagementGrantedRole `json:"roles"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

AuthorizationManagementGrantedRoleSearch - container for roles enabling cursor based pagination

type AuthorizationManagementGroupAccessGrant 

type AuthorizationManagementGroupAccessGrant struct {
	// The Group ID the Role will grant access to
	GroupId string `json:"groupId"`
	// The Role ID that will define the access
	RoleId string `json:"roleId"`
}

AuthorizationManagementGroupAccessGrant - The Group and Role another Group should have access to

type AuthorizationManagementOrganizationAccessGrant 

type AuthorizationManagementOrganizationAccessGrant struct {
	// The Role ID that will define the Organization access
	RoleId string `json:"roleId"`
}

AuthorizationManagementOrganizationAccessGrant - The Organization Role a Group should have access to

type AuthorizationManagementOrganizationStitchedFields 

type AuthorizationManagementOrganizationStitchedFields struct {
	// list of roles
	Roles AuthorizationManagementRoleSearch `json:"roles,omitempty"`
}

type AuthorizationManagementRevokeAccess 

type AuthorizationManagementRevokeAccess struct {
	// The Role and the Account the Target Group should no longer have access to
	AccountAccessGrants []AuthorizationManagementAccountAccessGrant `json:"accountAccessGrants,omitempty"`
	// The Role and the Group the Target Group should no longer have access to
	GroupAccessGrants []AuthorizationManagementGroupAccessGrant `json:"groupAccessGrants,omitempty"`
	// The Group ID that will have access revoked
	GroupId string `json:"groupId"`
	// The Role and the Organization the Target Group should no longer have access to
	OrganizationAccessGrants []AuthorizationManagementOrganizationAccessGrant `json:"organizationAccessGrants,omitempty"`
}

AuthorizationManagementRevokeAccess - The input object representing the access to revoke for the group

type AuthorizationManagementRevokeAccessPayload 

type AuthorizationManagementRevokeAccessPayload struct {
	// the roles that were revoked from this group
	Roles []AuthorizationManagementGrantedRole `json:"roles"`
}

AuthorizationManagementRevokeAccessPayload - Autogenerated return type of RevokeAccess

type AuthorizationManagementRevokeAccessQueryResponse 

type AuthorizationManagementRevokeAccessQueryResponse struct {
	AuthorizationManagementRevokeAccessPayload AuthorizationManagementRevokeAccessPayload `json:"AuthorizationManagementRevokeAccess"`
}

type AuthorizationManagementRole 

type AuthorizationManagementRole struct {
	// the name of the object
	DisplayName string `json:"displayName,omitempty"`
	// a value that uniquely identifies this object
	ID string `json:"id"`
	// the name of the object
	Name string `json:"name"`
	// the scope of the role
	Scope string `json:"scope"`
	// the type of the role
	Type string `json:"type"`
}

AuthorizationManagementRole - a role grants access on an account or organization to groups of users

type AuthorizationManagementRoleSearch 

type AuthorizationManagementRoleSearch struct {
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// control the access granted to groups
	Roles []AuthorizationManagementRole `json:"roles"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

AuthorizationManagementRoleSearch - container for roles enabling cursor based pagination

type Authorizationmanagement 

type Authorizationmanagement struct {
	// contains filtered or unexported fields
}

func New 

func New(config config.Config) Authorizationmanagement

func (*Authorizationmanagement) AuthorizationManagementGrantAccess 

func (a *Authorizationmanagement) AuthorizationManagementGrantAccess(
	grantAccessOptions AuthorizationManagementGrantAccess,
) (*AuthorizationManagementGrantAccessPayload, error)

Grant access for a group

func (*Authorizationmanagement) AuthorizationManagementGrantAccessWithContext 

func (a *Authorizationmanagement) AuthorizationManagementGrantAccessWithContext(
	ctx context.Context,
	grantAccessOptions AuthorizationManagementGrantAccess,
) (*AuthorizationManagementGrantAccessPayload, error)

Grant access for a group

func (*Authorizationmanagement) AuthorizationManagementRevokeAccess 

func (a *Authorizationmanagement) AuthorizationManagementRevokeAccess(
	revokeAccessOptions AuthorizationManagementRevokeAccess,
) (*AuthorizationManagementRevokeAccessPayload, error)

Revoke access for a group

func (*Authorizationmanagement) AuthorizationManagementRevokeAccessWithContext 

func (a *Authorizationmanagement) AuthorizationManagementRevokeAccessWithContext(
	ctx context.Context,
	revokeAccessOptions AuthorizationManagementRevokeAccess,
) (*AuthorizationManagementRevokeAccessPayload, error)

Revoke access for a group

func (*Authorizationmanagement) GetRoles 

func (a *Authorizationmanagement) GetRoles(
	cursor string,
	iD []string,
) (*AuthorizationManagementRoleSearch, error)

list of roles

func (*Authorizationmanagement) GetRolesWithContext 

func (a *Authorizationmanagement) GetRolesWithContext(
	ctx context.Context,
	cursor string,
	iD []string,
) (*AuthorizationManagementRoleSearch, error)

list of roles

type MultiTenantAuthorizationRole 

type MultiTenantAuthorizationRole struct {
	// a value that uniquely identifies this object
	ID int `json:"id"`
	// the name of the object
	Name string `json:"name"`
	// The scope the role applies to
	Scope string `json:"scope"`
	// The type of role
	Type string `json:"type"`
}

MultiTenantAuthorizationRole - Describes a role within the system

type MultiTenantAuthorizationRoleCollection 

type MultiTenantAuthorizationRoleCollection struct {
	// collection of roles
	Items []MultiTenantAuthorizationRole `json:"items"`
	// an opaque cursor to supply with subsequent   requests to get the next page of results, null if there are no more pages
	NextCursor string `json:"nextCursor,omitempty"`
	// the total number of results
	TotalCount int `json:"totalCount"`
}

MultiTenantAuthorizationRoleCollection - An iterable collection of roles

type Organization 

type Organization struct {
	// This field provides access to AuthorizationManagement data.
	AuthorizationManagement AuthorizationManagementOrganizationStitchedFields `json:"authorizationManagement,omitempty"`
	// The customer id for the organization.
	CustomerId string `json:"customerId,omitempty"`
	// The name of the organization.
	Name string `json:"name,omitempty"`
	// The telemetry id for the organization
	TelemetryId string `json:"telemetryId,omitempty"`
}

Organization - The `Organization` object provides basic data about an organization.

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.