Documentation
¶
Overview ¶
Package sca provides the CyberArk SCA Access API client.
Index ¶
- func ServiceConfig() services.IdsecServiceConfig
- type SCAAccessService
- func (s *SCAAccessService) Elevate(ctx context.Context, req *models.ElevateRequest) (*models.ElevateResponse, error)
- func (s *SCAAccessService) ElevateGroups(ctx context.Context, req *models.GroupsElevateRequest) (*models.GroupsElevateResponse, error)
- func (s *SCAAccessService) ListEligibility(ctx context.Context, csp models.CSP) (*models.EligibilityResponse, error)
- func (s *SCAAccessService) ListGroupsEligibility(ctx context.Context, csp models.CSP) (*models.GroupsEligibilityResponse, error)
- func (s *SCAAccessService) ListOnDemandResources(ctx context.Context, req models.OnDemandRequest) ([]models.OnDemandResource, error)
- func (s *SCAAccessService) ListSessions(ctx context.Context, csp *models.CSP) (*models.SessionsResponse, error)
- func (s *SCAAccessService) RevokeSessions(ctx context.Context, req *models.RevokeRequest) (*models.RevokeResponse, error)
- func (s *SCAAccessService) ServiceConfig() services.IdsecServiceConfig
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ServiceConfig ¶
func ServiceConfig() services.IdsecServiceConfig
ServiceConfig returns the configuration for the SCA Access Service. It specifies the service name "sca-access" and requires the "isp" authenticator.
Types ¶
type SCAAccessService ¶
type SCAAccessService struct {
services.IdsecService
*services.IdsecBaseService
// contains filtered or unexported fields
}
SCAAccessService provides access to SCA API endpoints.
func NewSCAAccessService ¶
func NewSCAAccessService(authenticators ...auth.IdsecAuth) (*SCAAccessService, error)
NewSCAAccessService creates a new SCA Access Service instance. It follows the SDK service pattern with ISP authentication.
func NewSCAAccessServiceWithClient ¶
func NewSCAAccessServiceWithClient(client httpClient) *SCAAccessService
NewSCAAccessServiceWithClient creates a service with a custom HTTP client. This is primarily for testing with mock clients.
func (*SCAAccessService) Elevate ¶
func (s *SCAAccessService) Elevate(ctx context.Context, req *models.ElevateRequest) (*models.ElevateResponse, error)
Elevate requests JIT elevation for the specified targets. POST /api/access/elevate
func (*SCAAccessService) ElevateGroups ¶ added in v0.3.0
func (s *SCAAccessService) ElevateGroups(ctx context.Context, req *models.GroupsElevateRequest) (*models.GroupsElevateResponse, error)
ElevateGroups requests JIT elevation for the specified Entra ID groups. POST /api/access/elevate/groups
func (*SCAAccessService) ListEligibility ¶
func (s *SCAAccessService) ListEligibility(ctx context.Context, csp models.CSP) (*models.EligibilityResponse, error)
ListEligibility retrieves all eligible targets for the specified CSP, automatically paginating through all pages via nextToken. GET /api/access/{CSP}/eligibility
func (*SCAAccessService) ListGroupsEligibility ¶ added in v0.3.0
func (s *SCAAccessService) ListGroupsEligibility(ctx context.Context, csp models.CSP) (*models.GroupsEligibilityResponse, error)
ListGroupsEligibility retrieves all eligible Entra ID groups for the specified CSP, automatically paginating through all pages via nextToken. GET /api/access/{CSP}/eligibility/groups
func (*SCAAccessService) ListOnDemandResources ¶ added in v0.7.0
func (s *SCAAccessService) ListOnDemandResources(ctx context.Context, req models.OnDemandRequest) ([]models.OnDemandResource, error)
ListOnDemandResources fetches the list of roles available for on-demand access for the given workspace. Dispatches on PlatformName: azure_ad and aws use GET /api/cloud/resources/ondemand, azure_resource uses POST /api/cloud/cloud-roles/ondemand with a body including resourceType and ancestors.
func (*SCAAccessService) ListSessions ¶
func (s *SCAAccessService) ListSessions(ctx context.Context, csp *models.CSP) (*models.SessionsResponse, error)
ListSessions retrieves all active elevated sessions, optionally filtered by CSP, automatically paginating through all pages via nextToken. GET /api/access/sessions
func (*SCAAccessService) RevokeSessions ¶ added in v0.3.0
func (s *SCAAccessService) RevokeSessions(ctx context.Context, req *models.RevokeRequest) (*models.RevokeResponse, error)
RevokeSessions revokes one or more active sessions by their IDs. POST /api/access/sessions/revoke
func (*SCAAccessService) ServiceConfig ¶
func (s *SCAAccessService) ServiceConfig() services.IdsecServiceConfig
ServiceConfig returns the service configuration.
Source Files
Directories