1. Overview
To ensure a successful and secure integration between your organizational systems and the Spikerz platform, the following prerequisites must be addressed. This document outlines the systems, protocols, and configurations necessary to enable authentication, authorization, and employee lifecycle management within Spikerz.
2. Authentication Integration
Create a new "Spikerz" app:
2.1. Single Sign-On (SSO) Configuration
To config the app, please use the following values:
Identifier (Entity ID)
#1: https://app.spikerz.com (should be checked as Default)
Reply URL (Assertion Consumer Service URL)
#1: https://app.spikerz.com/__/auth/handler (should be checked as Default)
Sign on URL: https://app.spikerz.com/__/auth/handler
Relay State: https://app.spikerz.com/__/auth/handler
In SAML Certificates, keep the Verification certificates as Required No.
In Properies you can add the Spikerz Logo: https://app.spikerz.com/assets/spikerz-logo-black.svg
2.2. Attributes & Claims (User Role Mapping)
Requirement: Access to role attributes during authentication to assign user permissions within Spikerz.
Details to Provide:
Attribute name used for role assignment.
Role definitions and mappings to Spikerz roles (e.g., Admin, Manager, Viewer).
Spikerz to SSO Attribute Mapping
Claim name | Value |
Unique User Identifier (Name ID) (Important!) | user.mail [nameid-format:emailAddress] |
displayName | user.displayname |
user.mail |
Please share with us the App Federation Metadata Url.
3. Authorization and Access Management
3.1. Role-Based Access Control (RBAC)
Requirement:
Roles must be provisioned as part of the authentication process.
Permissions based on roles should align with organizational security policies.
3.2. Group Membership (Optional)
Requirement:
Access to group membership attributes if authorization is determined by group affiliations.
Let’s start by creating those groups:
{OPTIONAL_YOUR_PREFIX}-spikerz-marketing-admins
{OPTIONAL_YOUR_PREFIX}-spikerz-security-admins
{OPTIONAL_YOUR_PREFIX}-spikerz-marketing-members
{OPTIONAL_YOUR_PREFIX}-spikerz-security-members
We’ll expand this in the near future by adding more groups based on teams and departments.
Before proceeding, please let us know who you plan to add to each group, and let’s make sure we get manager approval for the assignments.
Employee Lifecycle Management
4.1. SCIM Integration
Provisioning config:
Make sure you’ve turned on the provisioning method to SCIM 2.0
Use the Spikerz SCIM endpoint:
Use the token Spikerz provided to you
Make sure you have selected all provisioning actions and set the unique identifier to email.
Click start provisioning
