Skip to content
  • Auto
  • Light
  • Dark
Get Started

Create Providers

Search
client.Search.StepUp.NewProviders(ctx, body) (*ListarrayNextPageTokenstringSearchStepUpNewProvidersResponse, error)
post/api/v1/search/step-up/providers

Search allows searching for step-up providers with various filters

Parameters
bodyPageSizefieldPageTokenfieldProviderTypefieldQueryfieldRefsfieldSearchStepUpNewProvidersParams
Hide ParametersShow Parameters
PageSizefield
optional
param.Field[int64]

Maximum number of results to return

formatint32
PageTokenfield
optional
param.Field[string]

Token for pagination

ProviderTypefield
optional

The providerType field.

Hide ParametersShow Parameters
SearchStepUpNewProvidersParamsProviderTypeProviderTypeUnspecifiedconst
"PROVIDER_TYPE_UNSPECIFIED"
SearchStepUpNewProvidersParamsProviderTypeProviderTypeOauth2const
"PROVIDER_TYPE_OAUTH2"
SearchStepUpNewProvidersParamsProviderTypeProviderTypeMicrosoftconst
"PROVIDER_TYPE_MICROSOFT"
Queryfield
optional
param.Field[string]

Filter by name (partial match)

Refsfield
optional

The refs field.

Hide ParametersShow Parameters
IDstring
optional

The id field.

Returns
SearchStepUpNewProvidersResponsestruct

Response message for searching step-up providers

Hide ParametersShow Parameters
Listarray
optional
[]IDstringClientIDstringCreatedAtTimeDisplayNamestringEnabledboolIssuerURLstringLastTestedAtTimeMicrosoftStepUpMicrosoftSettingsOauth2StepUpOauth2SettingsUpdatedAtTimeStepUpProvider

List of providers matching the search criteria

Hide ParametersShow Parameters
IDstring
optional

The id field.

ClientIDstring
optional

The clientId field.

CreatedAtTime
optional
formatdate-time
DisplayNamestring
optional

The displayName field.

Enabledbool
optional

The enabled field.

IssuerURLstring
optional

The issuerUrl field.

LastTestedAtTime
optional
formatdate-time
MicrosoftConditionalAccessIDsarrayTenantstringStepUpMicrosoftSettings
optional

StepUpMicrosoftSettings represents a Microsoft Entra Provider using Conditional Access Policies to enforce step-up authentication.

Oauth2AcrValuesarrayStepUpOauth2Settings
optional

StepUpOAuth2Settings repersents an OAuth2 provider that supports RFC 9470 https://www.rfc-editor.org/rfc/rfc9470

Common ACR values for OAuth2 providers include:

  • "urn:okta:loa:1fa:any" (okta)
  • "urn:okta:loa:1fa:pwd" (okta)
  • "urn:okta:loa:2fa:any" (okta)
  • "urn:okta:loa:2fa:any:ifpossible" (okta)
  • "phr" (okta)
  • "phrh" (okta)
UpdatedAtTime
optional
formatdate-time
NextPageTokenstring
optional

Token for retrieving the next page of results

Request example Go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Search.StepUp.NewProviders(context.TODO(), conductoronesdk.SearchStepUpNewProvidersParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.List)
}
200 Example
{
  "list": [
    {
      "clientId": "clientId",
      "displayName": "displayName",
      "enabled": true,
      "issuerUrl": "issuerUrl",
      "microsoft": {
        "conditionalAccessIds": [
          "string"
        ],
        "tenant": "tenant"
      },
      "oauth2": {
        "acrValues": [
          "string"
        ]
      }
    }
  ],
  "nextPageToken": "nextPageToken"
}