IAM: The documentation for the StackOne Unified API - IAM
The SDK can be installed using RubyGems:
gem install stackone_client
require 'stackone_client'
s = ::StackOne::StackOne.new
s.config_security(
::StackOne::Shared::Security.new(
password: "",
username: "",
)
)
req = ::StackOne::Operations::HrisListEmployeesRequest.new(
expand: "company,employments,work_location,home_location,custom_fields,groups",
fields_: "id,remote_id,first_name,last_name,name,display_name,gender,ethnicity,date_of_birth,birthday,marital_status,avatar_url,avatar,personal_email,personal_phone_number,work_email,work_phone_number,job_id,remote_job_id,job_title,job_description,department_id,remote_department_id,department,cost_centers,benefits,manager_id,remote_manager_id,hire_date,start_date,tenure,work_anniversary,employment_type,employment_contract_type,employment_status,termination_date,company_name,preferred_language,citizenships,home_location,work_location,employments,custom_fields,documents,created_at,updated_at,employee_number,national_identity_number",
filter: ::StackOne::Operations::HrisListEmployeesQueryParamFilter.new(
updated_after: "2020-01-01T00:00:00.000Z",
),
include: "avatar_url,avatar,custom_fields,job_description,benefits",
x_account_id: "<id>",
)
res = s.hris.list_employees(req)
if ! res.employees_paginated.nil?
# handle response
end
Available methods
- delete_account - Delete Account
- get_account - Get Account
- get_account_meta_info - Get meta information of the account
- list_linked_accounts - List Accounts
- update_account - Update Account
- create_application - Create Application
- create_candidate - Create Candidate
- create_candidate_note - Create Candidate Note
- create_job - Create Job
- create_offer - Creates an offer
- download_application_document - Download Application Document
- get_application - Get Application
- get_application_custom_field_definition - Get Application Custom Field Definition
- get_application_document - Get Application Document
- get_application_offer - Get Application Offer
- get_application_scheduled_interview - Get Applications scheduled interview
- get_application_scorecard - Get Application Scorecard
- get_assessments_package - Get Assessments Package
- get_assessments_request - Get Assessments Requests
- get_assessments_result - Get Assessments Results
- get_candidate - Get Candidate
- get_candidate_custom_field_definition - Get Candidate Custom Field Definition
- get_candidate_note - Get Candidate Note
- get_department - Get Department
- get_interview - Get Interview
- get_interview_stage - Get Interview Stage
- get_job - Get Job
- get_job_custom_field_definition - Get Job Custom Field Definition
- get_job_posting - Get Job Posting
- get_list - Get List
- get_location - Get Location
- get_offer - Get Offer
- get_rejected_reason - Get Rejected Reason
- get_user - Get User
- list_application_custom_field_definitions - List Application Custom Field Definitions
- list_application_documents - List Application Documents
- list_application_scorecards - List Application Scorecards
- list_applications - List Applications
- list_applications_offers - List Application Offers
- list_applications_scheduled_interviews - List Applications scheduled interviews
- list_assessments_packages - List Assessments Packages
- list_candidate_custom_field_definitions - List Candidate Custom Field Definitions
- list_candidate_notes - List Candidate Notes
- list_candidates - List Candidates
- list_departments - List Departments
- list_interview_stages - List Interview Stages
- list_interviews - List Interviews
- list_job_custom_field_definitions - List Job Custom Field Definitions
- list_job_postings - List Job Postings
- list_jobs - List Jobs
- list_lists - Get all Lists
- list_locations - List locations
- list_offers - List Offers
- list_rejected_reasons - List Rejected Reasons
- list_users - List Users
- move_application - Move Application
- reject_application - Reject Application
- update_application - Update an Application
- update_candidate - Update Candidate
- update_job - Update Job
- upload_application_document - Upload Application Document
- authenticate_connect_session - Authenticate Connect Session
- create_connect_session - Create Connect Session
- get_connector_meta - Get Connector Meta information for the given provider key
- list_connectors_meta - List Connectors Meta Information for all providers
- create_contact - Creates a new Contact
- get_account - Get Account
- get_contact - Get Contact
- get_contact_custom_field_definition - Get Contact Custom Field Definition
- get_list - Get List
- list_accounts - List Accounts
- list_contact_custom_field_definitions - List Contact Custom Field Definitions
- list_contacts - List Contacts
- list_lists - Get all Lists
- update_contact - Update Contact (early access)
- batch_upload_employee_document - Batch Upload Employee Document
- create_employee - Creates an employee
- create_employee_employment - Create Employee Employment
- create_employee_time_off_request - Create Employee Time Off Request
- create_employee_work_eligibility_request - Create Employee Work Eligibility Request
- create_time_off_request - Creates a time off request
- download_employee_document - Download Employee Document
- get_benefit - Get Benefit
- get_company - Get Company
- get_cost_center_group - Get Cost Center Group
- get_department_group - Get Department Group
- get_employee - Get Employee
- get_employee_document - Get Employee Document
- get_employee_document_category - Get Employee Document Category
- get_employee_employment - Get Employee Employment
- get_employees_time_off_request - Get Employees Time Off Request
- get_employees_work_eligibility - Get Employees Work Eligibility
- get_employment - Get Employment
- get_group - Get Group
- get_job - Get Job
- get_location - Get Location
- get_time_off_request - Get time off request
- list_benefits - List benefits
- list_companies - List Companies
- list_cost_center_groups - List Cost Center Groups
- list_department_groups - List Department Groups
- list_employee_categories - List Employee Document Categories
- list_employee_documents - List Employee Documents
- list_employee_employments - List Employee Employments
- list_employee_time_off_requests - List Employee Time Off Requests
- list_employee_work_eligibility - List Employee Work Eligibility
- list_employees - List Employees
- list_employments - List Employments
- list_groups - List Groups
- list_jobs - List Jobs
- list_locations - List locations
- list_time_off_requests - List time off requests
- update_employee - Updates an employee
- update_employee_employment - Update Employee Employment
- update_employee_work_eligibility_request - Update Employee Work Eligibility Request
- update_time_off_request - Update time off request
- upload_employee_document - Upload Employee Document
- get_group - Get Group
- get_policy - Get Policy
- get_role - Get Role
- get_user - Get User
- list_groups - List Groups
- list_policies - List Policies
- list_roles - List Roles
- list_users - List Users
- batch_upsert_content - Batch Upsert Content
- batch_upsert_course - Batch Upsert Course
- create_content - Create Content
- create_user_completion - Create User Completion
- delete_content - Delete Content
- get_assignment - Get Assignment
- get_category - Get Category
- get_completion - Get Completion
- get_content - Get Content
- get_course - Get Course
- get_skill - Get Skill
- get_user - Get User
- get_user_assignment - Get User Assignment
- get_user_completion - Get User Completion
- list_assignments - List Assignments
- list_categories - List Categories
- list_completions - List Completions
- list_content - List Content
- list_courses - List Courses
- list_skills - List Skills
- list_user_assignments - List User Assignments
- list_user_completions - List User Completions
- list_users - List Users
- update_content - Update Content
- upsert_content - Upsert Content
- upsert_course - Upsert Course
- create_content_block - Create Content Block
- create_email_template - Create Email Templates
- create_in_app_template - Create In-App Template
create_omni_channel_template- Create Omni-Channel Template⚠️ Deprecated- create_push_template - Create Push Template
- create_sms_template - Create SMS Template
- get_campaign - Get campaign
- get_content_block - Get Content Blocks
- get_email_template - Get Email Templates
- get_in_app_template - Get In-App Template
get_omni_channel_template- Get Omni-Channel Template⚠️ Deprecated- get_push_template - Get Push Template
- get_sms_template - Get SMS Template
- list_campaigns - List campaigns
- list_content_blocks - List Content Blocks
- list_email_templates - List Email Templates
- list_in_app_templates - List In-App Templates
list_omni_channel_templates- List Omni-Channel Templates⚠️ Deprecated- list_push_templates - List Push Templates
- list_sms_templates - List SMS Templates
- update_content_block - Update Content Block
- update_email_template - Update Email Templates
- update_in_app_template - Update In-App Template
update_omni_channel_template- Update Omni-Channel Template⚠️ Deprecated- update_push_template - Update Push Template
- update_sms_template - Update SMS Template
- proxy_request - Proxy Request
You can override the default server globally by passing a server index to the server_idx: int
optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
# | Server | Variables |
---|---|---|
0 | https://api.stackone.com |
None |
The default server can also be overridden globally by passing a URL to the server_url: str
optional parameter when initializing the SDK client instance. For example:
This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!