Skip to content

Get endpoint OIDC provider

GET
/v1/endpoint-oidc-providers/{endpointOIDCProviderID}

Fetch information about a particular endpoint OIDC provider.

Token scope required: endpoint-oidc-providers:read

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
endpointOIDCProviderID
required
string
Example
endpointoidc-WDRO5WY4LTKA2AALKZQ2OHBSDE

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful operation

object
data
required
object
id
required
string
Example
endpointoidc-WDRO5WY4LTKA2AALKZQ2OHBSDE
organizationID
required
string
Example
org-F63A24JGCLJV3ZEUTLCBISGETA
name
required
string
Example
Corporate SSO
clientID
required
string
Example
0oa1b2c3d4e5f6g7h8i9
issuerURL
required
string format: uri
Example
https://example.okta.com
enabled
required

Whether users can enroll hosts by signing in with this provider.

boolean
networkID
required

Network that hosts enrolled through this provider join.

string
Example
network-KAOWMXZHZWCVMGGFKM22XEGYLE
roleID
required

Role assigned to hosts enrolled through this provider.

string | null
Example
role-PZEDBXHCEXKAKJPZ6XOQTIAJA4
authValidityHours
required

How long, in hours, a host keeps network access after its user signs in. null means access does not expire.

integer | null
Example
720
domainID
required

Email domain whose users may sign in with this provider.

string | null
Example
domain-3QZRDHZ5SZBQ5DBHUQE6GSMXGI
autoAssignCIDRs
required

Prefixes from which hosts enrolled through this provider are assigned addresses. Includes the network’s IPv6 prefix whenever the network has one.

array | null
Example
[
  "100.100.0.0/22",
  "fdef:c0:c0:1::/80"
]
Example
{
  "data": {
    "id": "endpointoidc-WDRO5WY4LTKA2AALKZQ2OHBSDE",
    "organizationID": "org-F63A24JGCLJV3ZEUTLCBISGETA",
    "name": "Corporate SSO",
    "clientID": "0oa1b2c3d4e5f6g7h8i9",
    "issuerURL": "https://example.okta.com",
    "enabled": true,
    "networkID": "network-KAOWMXZHZWCVMGGFKM22XEGYLE",
    "roleID": "role-PZEDBXHCEXKAKJPZ6XOQTIAJA4",
    "authValidityHours": 720,
    "domainID": "domain-3QZRDHZ5SZBQ5DBHUQE6GSMXGI",
    "autoAssignCIDRs": [
      "100.100.0.0/22",
      "fdef:c0:c0:1::/80"
    ]
  }
}

401

Section titled “401 ”

The API key is missing, invalid or expired.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_UNAUTHORIZED",
      "message": "unauthorized"
    }
  ]
}

403

Section titled “403 ”

The API key lacks a required scope.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Examples

The API key lacks a required scope.

{
  "errors": [
    {
      "code": "ERR_FORBIDDEN",
      "message": "api key must support the following scopes: hosts:read"
    }
  ]
}

404

Section titled “404 ”

Endpoint OIDC provider not found

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_NOT_FOUND",
      "message": "resource not found"
    }
  ]
}

429

Section titled “429 ”

The organization has exceeded its API request rate limit. Retry the request after a short delay.

object
errors
required
Array<object>
object
code
required

A static name for the error type

string
message
required

A short human readable description of the error

string
path

Describes the variable missing or malformed

string
param

The query parameter the error relates to, such as filter.targetType

string
extra

Machine-readable details about the error. ERR_LIMIT_EXCEEDED errors carry limit and limitName.

object
limit

The maximum number of resources allowed

integer
limitName

The kind of resource the limit applies to

string
key
additional properties
any
Example
{
  "errors": [
    {
      "code": "ERR_TOO_MANY_REQUESTS",
      "message": "too many requests"
    }
  ]
}