For the complete documentation index, see llms.txt. This page is also available as Markdown.

IDP

Remove IDP integration

delete
Authorizations
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
delete/api/idp
DELETE /api/idp HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
{
  "code": 1,
  "message": "text",
  "response": null
}

Sync users and groups from IDP

post
Authorizations
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
post/api/idp/sync
POST /api/idp/sync HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
200

OK

{
  "code": 1,
  "message": "text",
  "response": null
}

Get IDP sync status

get
Authorizations
Responses
200

OK

application/json
descriptionstringOptional

Description is empty if the sync is ongoing or completed, and describes the error when the sync fails.

statusstringOptional

Status would be one of: in_progress, completed or failed.

get/api/idp/sync/status
GET /api/idp/sync/status HTTP/1.1
Host: api.demo.netmaker.io
Accept: */*
200

OK

{
  "description": "text",
  "status": "text"
}

Test IDP Sync Credentials

post
Authorizations
Body
auth_providerstringOptional
azure_tenant_idstringOptional
client_idstringOptional
client_secretstringOptional
google_admin_emailstringOptional
google_sa_creds_jsonstringOptional
okta_api_tokenstringOptional
okta_org_urlstringOptional
Responses
200

OK

application/json
codeintegerOptional
messagestringOptional
responseanyOptional
post/api/idp/sync/test
POST /api/idp/sync/test HTTP/1.1
Host: api.demo.netmaker.io
Content-Type: application/json
Accept: */*
Content-Length: 195

{
  "auth_provider": "text",
  "azure_tenant_id": "text",
  "client_id": "text",
  "client_secret": "text",
  "google_admin_email": "text",
  "google_sa_creds_json": "text",
  "okta_api_token": "text",
  "okta_org_url": "text"
}
{
  "code": 1,
  "message": "text",
  "response": null
}

Last updated

Was this helpful?