Skip to content

README.md

Latest commit

 

History

History
64 lines (47 loc) · 4.13 KB

README.md

File metadata and controls

64 lines (47 loc) · 4.13 KB

AuthConfigs

Overview

View and manage connector auth configurations for the project.

Available Operations

list_auth_configs

List the auth configs available to the project.

Example Usage

require 'stackone_client'

Models = ::StackOne::Models
s = ::StackOne::StackOne.new(
  security: Models::Shared::Security.new(
    password: '',
    username: ''
  )
)
res = s.auth_configs.list_auth_configs(connector_key: 'salesforce', enabled: true, page_size: 25.0)

unless res.auth_configs_paginated.nil?
  # handle response
end

Parameters

Parameter Type Required Description Example
connector_key T.nilable(::String) ➖ Filter auth configs by connector key salesforce
enabled T.nilable(T::Boolean) ➖ Filter auth configs by their enabled state true
page T.nilable(::Float) ➖ The page number of the results to fetch
page_size T.nilable(::Float) ➖ The number of results per page

Response

T.nilable(Models::Operations::StackoneListAuthConfigsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::BadRequestResponse 400 application/json
Models::Errors::UnauthorizedResponse 401 application/json
Models::Errors::ForbiddenResponse 403 application/json
Models::Errors::NotFoundResponse 404 application/json
Models::Errors::RequestTimedOutResponse 408 application/json
Models::Errors::ConflictResponse 409 application/json
Models::Errors::UnprocessableEntityResponse 422 application/json
Models::Errors::TooManyRequestsResponse 429 application/json
Models::Errors::InternalServerErrorResponse 500 application/json
Models::Errors::NotImplementedResponse 501 application/json
Models::Errors::BadGatewayResponse 502 application/json
Errors::APIError 4XX, 5XX */*