identity

type AddGroupMemberBody struct {
	Name string `json:"name"`
}

type AddGroupRoleBody struct {
	Name string `json:"name"`
}

type AddMemberBody struct {
	Name string `json:"name"`
}

type AddRolePermissionBody string

type CreateGroupBody struct {
	Name string `json:"name"`
}

type CreateRoleBody struct {
	Name string `json:"name"`
}

type Group struct {
	CreatedAt   string `json:"createdAt"`
	CreatedBy   string `json:"createdBy"`
	MemberCount int32  `json:"memberCount"`
	Name        string `json:"name"`
	RoleCount   int32  `json:"roleCount"`
	Tenant      string `json:"tenant"`
}

type GroupMember struct {
	AddedAt   string `json:"addedAt"`
	AddedBy   string `json:"addedBy"`
	Group     string `json:"group"`
	Principal string `json:"principal"`
	Tenant    string `json:"tenant"`
}

type GroupRole struct {
	AddedAt string `json:"addedAt"`
	AddedBy string `json:"addedBy"`
	Group   string `json:"group"`
	Role    string `json:"role"`
	Tenant  string `json:"tenant"`
}

type Member struct {
	// When the principal was added to the tenant.
	AddedAt string            `json:"addedAt"`
	AddedBy string            `json:"addedBy"`
	Name    string            `json:"name"`
	Tenant  string            `json:"tenant"`
	Profile *PrincipalProfile `json:"profile,omitempty"`
}

type Principal struct {
	CreatedAt string            `json:"createdAt"`
	CreatedBy string            `json:"createdBy"`
	Kind      PrincipalKind     `json:"kind"`
	Name      string            `json:"name"`
	Tenants   []string          `json:"tenants"`
	UpdatedAt string            `json:"updatedAt"`
	UpdatedBy string            `json:"updatedBy"`
	Profile   *PrincipalProfile `json:"profile,omitempty"`
}

type PrincipalKind string

type PrincipalProfile struct {
	Email    *string `json:"email,omitempty"`
	FullName *string `json:"fullName,omitempty"`
}

type Role struct {
	CreatedAt string `json:"createdAt"`
	CreatedBy string `json:"createdBy"`
	Name      string `json:"name"`
	Tenant    string `json:"tenant"`
}

type RolePermission struct {
	AddedAt    string `json:"addedAt"`
	AddedBy    string `json:"addedBy"`
	Permission string `json:"permission"`
	Role       string `json:"role"`
	Tenant     string `json:"tenant"`
}

type Service services.BaseService

type Servicer interface {
	/*
		AddGroupMember - identity service endpoint
		Adds a member to a given group.
		Parameters:
			group: The group name.
			addGroupMemberBody: The member to add to a group.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddGroupMember(group string, addGroupMemberBody AddGroupMemberBody, resp ...*http.Response) (*GroupMember, error)
	/*
		AddGroupRole - identity service endpoint
		Adds a role to a given group.
		Parameters:
			group: The group name.
			addGroupRoleBody: The role to add to a group.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddGroupRole(group string, addGroupRoleBody AddGroupRoleBody, resp ...*http.Response) (*GroupRole, error)
	/*
		AddMember - identity service endpoint
		Adds a member to a given tenant.
		Parameters:
			addMemberBody: The member to associate with a tenant.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddMember(addMemberBody AddMemberBody, resp ...*http.Response) (*Member, error)
	/*
		AddRolePermission - identity service endpoint
		Adds permissions to a role in a given tenant.
		Parameters:
			role: The role name.
			body: The permission to add to a role.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	AddRolePermission(role string, body string, resp ...*http.Response) (*RolePermission, error)
	/*
		CreateGroup - identity service endpoint
		Creates a new group in a given tenant.
		Parameters:
			createGroupBody: The group definition.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateGroup(createGroupBody CreateGroupBody, resp ...*http.Response) (*Group, error)
	/*
		CreateRole - identity service endpoint
		Creates a new authorization role in a given tenant.
		Parameters:
			createRoleBody: Role definition
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateRole(createRoleBody CreateRoleBody, resp ...*http.Response) (*Role, error)
	/*
		DeleteGroup - identity service endpoint
		Deletes a group in a given tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteGroup(group string, resp ...*http.Response) error
	/*
		DeleteRole - identity service endpoint
		Deletes a defined role for a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRole(role string, resp ...*http.Response) error
	/*
		GetGroup - identity service endpoint
		Returns information about a given group within a tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroup(group string, resp ...*http.Response) (*Group, error)
	/*
		GetGroupMember - identity service endpoint
		Returns information about a given member within a given group.
		Parameters:
			group: The group name.
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroupMember(group string, member string, resp ...*http.Response) (*GroupMember, error)
	/*
		GetGroupRole - identity service endpoint
		Returns information about a given role within a given group.
		Parameters:
			group: The group name.
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetGroupRole(group string, role string, resp ...*http.Response) (*GroupRole, error)
	/*
		GetMember - identity service endpoint
		Returns a member of a given tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetMember(member string, resp ...*http.Response) (*Member, error)
	/*
		GetPrincipal - identity service endpoint
		Returns the details of a principal, including its tenant membership.
		Parameters:
			principal: The principal name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetPrincipal(principal string, resp ...*http.Response) (*Principal, error)
	/*
		GetRole - identity service endpoint
		Returns a role for a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRole(role string, resp ...*http.Response) (*Role, error)
	/*
		GetRolePermission - identity service endpoint
		Gets a permission for the specified role.
		Parameters:
			role: The role name.
			permission: The permission string.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRolePermission(role string, permission string, resp ...*http.Response) (*RolePermission, error)
	/*
		ListGroupMembers - identity service endpoint
		Returns a list of the members within a given group.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroupMembers(group string, resp ...*http.Response) ([]string, error)
	/*
		ListGroupRoles - identity service endpoint
		Returns a list of the roles that are attached to a group within a given tenant.
		Parameters:
			group: The group name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroupRoles(group string, resp ...*http.Response) ([]string, error)
	/*
		ListGroups - identity service endpoint
		List the groups that exist in a given tenant.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListGroups(resp ...*http.Response) ([]string, error)
	/*
		ListMemberGroups - identity service endpoint
		Returns a list of groups that a member belongs to within a tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberGroups(member string, resp ...*http.Response) ([]string, error)
	/*
		ListMemberPermissions - identity service endpoint
		Returns a set of permissions granted to the member within the tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberPermissions(member string, resp ...*http.Response) ([]string, error)
	/*
		ListMemberRoles - identity service endpoint
		Returns a set of roles that a given member holds within the tenant.
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMemberRoles(member string, resp ...*http.Response) ([]string, error)
	/*
		ListMembers - identity service endpoint
		Returns a list of members in a given tenant.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListMembers(resp ...*http.Response) ([]string, error)
	/*
		ListPrincipals - identity service endpoint
		Returns the list of principals known to IAC.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListPrincipals(resp ...*http.Response) ([]string, error)
	/*
		ListRoleGroups - identity service endpoint
		Gets a list of groups for a role in a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRoleGroups(role string, resp ...*http.Response) ([]string, error)
	/*
		ListRolePermissions - identity service endpoint
		Gets the permissions for a role in a given tenant.
		Parameters:
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRolePermissions(role string, resp ...*http.Response) ([]string, error)
	/*
		ListRoles - identity service endpoint
		Returns all roles for a given tenant.
		Parameters:
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRoles(resp ...*http.Response) ([]string, error)
	/*
		RemoveGroupMember - identity service endpoint
		Removes the member from a given group.
		Parameters:
			group: The group name.
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveGroupMember(group string, member string, resp ...*http.Response) error
	/*
		RemoveGroupRole - identity service endpoint
		Removes a role from a given group.
		Parameters:
			group: The group name.
			role: The role name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveGroupRole(group string, role string, resp ...*http.Response) error
	/*
		RemoveMember - identity service endpoint
		Removes a member from a given tenant
		Parameters:
			member: The member name.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveMember(member string, resp ...*http.Response) error
	/*
		RemoveRolePermission - identity service endpoint
		Removes a permission from the role.
		Parameters:
			role: The role name.
			permission: The permission string.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	RemoveRolePermission(role string, permission string, resp ...*http.Response) error
	/*
		ValidateToken - identity service endpoint
		Validates the access token obtained from the authorization header and returns the principal name and tenant memberships.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ValidateToken(query *ValidateTokenQueryParams, resp ...*http.Response) (*ValidateInfo, error)
}

type Tenant struct {
	CreatedAt string       `json:"createdAt"`
	CreatedBy string       `json:"createdBy"`
	Name      string       `json:"name"`
	Status    TenantStatus `json:"status"`
}

type TenantName string

type TenantStatus string

type ValidateInfo struct {
	ClientId  string     `json:"clientId"`
	Name      string     `json:"name"`
	Principal *Principal `json:"principal,omitempty"`
	Tenant    *Tenant    `json:"tenant,omitempty"`
}

type ValidateTokenQueryParams struct {
	// Include : Include additional information to return when validating tenant membership. Valid parameters [tenant, principal]
	Include []string `key:"include"`
}