Files
netbird-docs/src/pages/ipa/resources/idp-okta-scim-integrations.mdx
2026-04-02 18:34:35 +00:00

1604 lines
31 KiB
Plaintext

export const title = 'IDP Okta SCIM Integrations'
## Create Okta SCIM IDP Integration {{ tag: 'POST' , label: '/api/integrations/okta-scim-idp' }}
<Row>
<Col>
Creates a new Okta SCIM IDP integration
### Request-Body Parameters
<Properties><Property name="group_prefixes" type="string[]" required={false}>
List of start_with string patterns for groups to sync
</Property>
<Property name="user_group_prefixes" type="string[]" required={false}>
List of start_with string patterns for groups which users to sync
</Property>
<Property name="connector_id" type="string" required={false}>
DEX connector ID for embedded IDP setups
</Property>
<Property name="connection_name" type="string" required={true}>
The Okta enterprise connection name on Auth0
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/integrations/okta-scim-idp">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/integrations/okta-scim-idp \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
});
let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp"
payload = json.dumps({
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp"
method := "POST"
payload := strings.NewReader(`{
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => '{
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"connection_name": "my-okta-connection"
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"id": 1,
"auth_token": "nbs_abc***********************************",
"last_synced_at": "2023-05-15T10:30:00Z"
}
```
```json {{ title: 'Schema' }}
{
"enabled": "boolean",
"group_prefixes": [
"string"
],
"user_group_prefixes": [
"string"
],
"connector_id": "string",
"id": "integer",
"auth_token": "string",
"last_synced_at": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Get All Okta SCIM IDP Integrations {{ tag: 'GET' , label: '/api/integrations/okta-scim-idp' }}
<Row>
<Col>
Retrieves all Okta SCIM IDP integrations for the authenticated account
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/integrations/okta-scim-idp">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/integrations/okta-scim-idp \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"id": 1,
"auth_token": "nbs_abc***********************************",
"last_synced_at": "2023-05-15T10:30:00Z"
}
]
```
```json {{ title: 'Schema' }}
[
{
"enabled": "boolean",
"group_prefixes": [
"string"
],
"user_group_prefixes": [
"string"
],
"connector_id": "string",
"id": "integer",
"auth_token": "string",
"last_synced_at": "string"
}
]
```
</CodeGroup>
</Col>
</Row>
---
## Get Okta SCIM IDP Integration {{ tag: 'GET' , label: '/api/integrations/okta-scim-idp/{id}' }}
<Row>
<Col>
Retrieves an Okta SCIM IDP integration by ID.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/integrations/okta-scim-idp/{id}">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/integrations/okta-scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp/{id}',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp/{id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"id": 1,
"auth_token": "nbs_abc***********************************",
"last_synced_at": "2023-05-15T10:30:00Z"
}
```
```json {{ title: 'Schema' }}
{
"enabled": "boolean",
"group_prefixes": [
"string"
],
"user_group_prefixes": [
"string"
],
"connector_id": "string",
"id": "integer",
"auth_token": "string",
"last_synced_at": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Update Okta SCIM IDP Integration {{ tag: 'PUT' , label: '/api/integrations/okta-scim-idp/{id}' }}
<Row>
<Col>
Updates an existing Okta SCIM IDP integration.
### Request-Body Parameters
<Properties><Property name="enabled" type="boolean" required={false}>
Whether the integration is enabled
</Property>
<Property name="group_prefixes" type="string[]" required={false}>
List of start_with string patterns for groups to sync
</Property>
<Property name="user_group_prefixes" type="string[]" required={false}>
List of start_with string patterns for groups which users to sync
</Property>
<Property name="connector_id" type="string" required={false}>
DEX connector ID for embedded IDP setups
</Property>
</Properties>
</Col>
<Col sticky>
<CodeGroup title="Request" tag="PUT" label="/api/integrations/okta-scim-idp/{id}">
```bash {{ title: 'cURL' }}
curl -X PUT https://api.netbird.io/api/integrations/okta-scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Authorization: Token <TOKEN>' \
--data-raw '{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
}'
```
```js
const axios = require('axios');
let data = JSON.stringify({
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
});
let config = {
method: 'put',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp/{id}',
headers: {
'Accept': 'application/json',
'Content-Type': 'application/json',
'Authorization': 'Token <TOKEN>'
},
data : data
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
payload = json.dumps({
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
})
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
method := "PUT"
payload := strings.NewReader(`{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Content-Type", "application/json")
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
request.body = JSON.dump({
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
})
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, '{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
}');
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp/{id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'PUT',
CURLOPT_POSTFIELDS => '{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
}
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json',
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"enabled": true,
"group_prefixes": [
"Engineering",
"Sales"
],
"user_group_prefixes": [
"Users"
],
"connector_id": {
"type": "string",
"description": "DEX connector ID for embedded IDP setups"
},
"id": 1,
"auth_token": "nbs_abc***********************************",
"last_synced_at": "2023-05-15T10:30:00Z"
}
```
```json {{ title: 'Schema' }}
{
"enabled": "boolean",
"group_prefixes": [
"string"
],
"user_group_prefixes": [
"string"
],
"connector_id": "string",
"id": "integer",
"auth_token": "string",
"last_synced_at": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Delete Okta SCIM IDP Integration {{ tag: 'DELETE' , label: '/api/integrations/okta-scim-idp/{id}' }}
<Row>
<Col>
Deletes an Okta SCIM IDP integration by ID.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="DELETE" label="/api/integrations/okta-scim-idp/{id}">
```bash {{ title: 'cURL' }}
curl -X DELETE https://api.netbird.io/api/integrations/okta-scim-idp/{id} \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'delete',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp/{id}',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("DELETE", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp/{id}"
method := "DELETE"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Delete.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp/{id}")
.method("DELETE")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp/{id}',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'DELETE',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{}
```
```json {{ title: 'Schema' }}
{
"type": "object",
"example": {}
}
```
</CodeGroup>
</Col>
</Row>
---
## Regenerate Okta SCIM Token {{ tag: 'POST' , label: '/api/integrations/okta-scim-idp/{id}/token' }}
<Row>
<Col>
Regenerates the SCIM API token for an Okta SCIM IDP integration.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="POST" label="/api/integrations/okta-scim-idp/{id}/token">
```bash {{ title: 'cURL' }}
curl -X POST https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'post',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp/{id}/token',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("POST", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token"
method := "POST"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token")
.method("POST")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp/{id}/token',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
{
"auth_token": "nbs_F3f0d..."
}
```
```json {{ title: 'Schema' }}
{
"auth_token": "string"
}
```
</CodeGroup>
</Col>
</Row>
---
## Get Okta SCIM Integration Sync Logs {{ tag: 'GET' , label: '/api/integrations/okta-scim-idp/{id}/logs' }}
<Row>
<Col>
Retrieves synchronization logs for an Okta SCIM IDP integration.
</Col>
<Col sticky>
<CodeGroup title="Request" tag="GET" label="/api/integrations/okta-scim-idp/{id}/logs">
```bash {{ title: 'cURL' }}
curl -X GET https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs \
-H 'Accept: application/json' \
-H 'Authorization: Token <TOKEN>'
```
```js
const axios = require('axios');
let config = {
method: 'get',
maxBodyLength: Infinity,
url: '/api/integrations/okta-scim-idp/{id}/logs',
headers: {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
};
axios(config)
.then((response) => {
console.log(JSON.stringify(response.data));
})
.catch((error) => {
console.log(error);
});
```
```python
import requests
import json
url = "https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs"
headers = {
'Accept': 'application/json',
'Authorization': 'Token <TOKEN>'
}
response = requests.request("GET", url, headers=headers)
print(response.text)
```
```go
package main
import (
"fmt"
"strings"
"net/http"
"io/ioutil"
)
func main() {
url := "https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs"
method := "GET"
client := &http.Client {
}
req, err := http.NewRequest(method, url, nil)
if err != nil {
fmt.Println(err)
return
{
req.Header.Add("Accept", "application/json")
req.Header.Add("Authorization", "Token <TOKEN>")
res, err := client.Do(req)
if err != nil {
fmt.Println(err)
return
}
defer res.Body.Close()
body, err := ioutil.ReadAll(res.Body)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(string(body))
}
```
```ruby
require "uri"
require "json"
require "net/http"
url = URI("https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs")
https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Token <TOKEN>"
response = https.request(request)
puts response.read_body
```
```java
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
Request request = new Request.Builder()
.url("https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs")
.method("GET")
.addHeader("Accept", "application/json")
.addHeader("Authorization: Token <TOKEN>")
.build();
Response response = client.newCall(request).execute();
```
```php
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://api.netbird.io/api/integrations/okta-scim-idp/{id}/logs',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Accept: application/json',
'Authorization: Token <TOKEN>'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
```
</CodeGroup>
<CodeGroup title="Response">
```json {{ title: 'Example' }}
[
{
"id": 123,
"level": "info",
"timestamp": "2023-05-15T10:30:00Z",
"message": "Successfully synchronized users and groups"
}
]
```
```json {{ title: 'Schema' }}
[
{
"id": "integer",
"level": "string",
"timestamp": "string",
"message": "string"
}
]
```
</CodeGroup>
</Col>
</Row>
---