Identity Providers

Operations Summary

Method	Endpoint	Description
GET	/api/identity-providers/	List Identity Providers
GET	/api/identity-providers/{provider}/	Retrieve
POST	/api/identity-providers/	Create
PUT	/api/identity-providers/{provider}/	Update
PATCH	/api/identity-providers/{provider}/	Partial Update
DELETE	/api/identity-providers/{provider}/	Delete

---

List Identity Providers

HTTPiePythonTypeScriptQuery ParametersResponses

http \
  GET \
  https://api.example.com/api/identity-providers/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_list # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_list.sync(client=client)

for item in response:
    print(item)

1. API Source: identity_providers_list

import { identityProvidersList } from 'waldur-js-client';

try {
  const response = await identityProvidersList({
  auth: "Token YOUR_API_TOKEN"
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Description
page	integer	A page number within the paginated result set.
page_size	integer	Number of results to return per page.

200 -

The response body is an array of objects, where each object has the following structure:

Field	Type	Description
provider	string
is_active	boolean
client_id	string	ID of application used for OAuth authentication.
client_secret	string	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	The endpoint for endpoint discovery.
userinfo_url	string	The endpoint for fetching user info.
token_url	string	The endpoint for obtaining auth token.
auth_url	string	The endpoint for authorization request flow.
logout_url	string	The endpoint used to redirect after sign-out.
label	string	Human-readable identity provider is label.
management_url	string	The endpoint for user details management.
protected_fields	any
extra_scope	string	Space-separated list of scopes to request during authentication.
user_field	string	The field in Waldur User model to be used for looking up the user
user_claim	string	The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any	A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string	Space-separated list of extra fields to persist.

---

Retrieve

HTTPiePythonTypeScriptPath ParametersResponses

http \
  GET \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_retrieve.sync(
    provider="string-value",
    client=client
)

print(response)

1. API Source: identity_providers_retrieve

import { identityProvidersRetrieve } from 'waldur-js-client';

try {
  const response = await identityProvidersRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
provider	string	✓

200 -

Field	Type	Description
provider	string
is_active	boolean
client_id	string	ID of application used for OAuth authentication.
client_secret	string	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	The endpoint for endpoint discovery.
userinfo_url	string	The endpoint for fetching user info.
token_url	string	The endpoint for obtaining auth token.
auth_url	string	The endpoint for authorization request flow.
logout_url	string	The endpoint used to redirect after sign-out.
label	string	Human-readable identity provider is label.
management_url	string	The endpoint for user details management.
protected_fields	any
extra_scope	string	Space-separated list of scopes to request during authentication.
user_field	string	The field in Waldur User model to be used for looking up the user
user_claim	string	The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any	A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string	Space-separated list of extra fields to persist.

---

Create

HTTPiePythonTypeScriptRequest Body (required)Responses

http \
  POST \
  https://api.example.com/api/identity-providers/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider="string-value" \
  client_id="string-value" \
  client_secret="********" \
  discovery_url="string-value" \
  label="string-value"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_provider_request import IdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_create # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityProviderRequest(
    provider="string-value",
    client_id="string-value",
    client_secret="********",
    discovery_url="string-value",
    label="string-value"
)
response = identity_providers_create.sync(
    client=client,
    body=body_data
)

print(response)

1. Model Source: IdentityProviderRequest
2. API Source: identity_providers_create

import { identityProvidersCreate } from 'waldur-js-client';

try {
  const response = await identityProvidersCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "provider": "string-value",
    "client_id": "string-value",
    "client_secret": "********",
    "discovery_url": "string-value",
    "label": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Field	Type	Required	Description
provider	string	✓
is_active	boolean
client_id	string	✓	ID of application used for OAuth authentication.
client_secret	string	✓	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	✓	The endpoint for endpoint discovery.
label	string	✓	Human-readable identity provider is label.
management_url	string		The endpoint for user details management.
protected_fields	any
extra_scope	string		Space-separated list of scopes to request during authentication.
user_field	string		The field in Waldur User model to be used for looking up the user
user_claim	string		The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any		A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string		Space-separated list of extra fields to persist.

201 -

Field	Type	Description
provider	string
is_active	boolean
client_id	string	ID of application used for OAuth authentication.
client_secret	string	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	The endpoint for endpoint discovery.
userinfo_url	string	The endpoint for fetching user info.
token_url	string	The endpoint for obtaining auth token.
auth_url	string	The endpoint for authorization request flow.
logout_url	string	The endpoint used to redirect after sign-out.
label	string	Human-readable identity provider is label.
management_url	string	The endpoint for user details management.
protected_fields	any
extra_scope	string	Space-separated list of scopes to request during authentication.
user_field	string	The field in Waldur User model to be used for looking up the user
user_claim	string	The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any	A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string	Space-separated list of extra fields to persist.

---

Update

HTTPiePythonTypeScriptPath ParametersRequest Body (required)Responses

http \
  PUT \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN" \
  provider="string-value" \
  client_id="string-value" \
  client_secret="********" \
  discovery_url="string-value" \
  label="string-value"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.identity_provider_request import IdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = IdentityProviderRequest(
    provider="string-value",
    client_id="string-value",
    client_secret="********",
    discovery_url="string-value",
    label="string-value"
)
response = identity_providers_update.sync(
    provider="string-value",
    client=client,
    body=body_data
)

print(response)

1. Model Source: IdentityProviderRequest
2. API Source: identity_providers_update

import { identityProvidersUpdate } from 'waldur-js-client';

try {
  const response = await identityProvidersUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  },
  body: {
    "provider": "string-value",
    "client_id": "string-value",
    "client_secret": "********",
    "discovery_url": "string-value",
    "label": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
provider	string	✓

Field	Type	Required	Description
provider	string	✓
is_active	boolean
client_id	string	✓	ID of application used for OAuth authentication.
client_secret	string	✓	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	✓	The endpoint for endpoint discovery.
label	string	✓	Human-readable identity provider is label.
management_url	string		The endpoint for user details management.
protected_fields	any
extra_scope	string		Space-separated list of scopes to request during authentication.
user_field	string		The field in Waldur User model to be used for looking up the user
user_claim	string		The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any		A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string		Space-separated list of extra fields to persist.

200 -

Field	Type	Description
provider	string
is_active	boolean
client_id	string	ID of application used for OAuth authentication.
client_secret	string	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	The endpoint for endpoint discovery.
userinfo_url	string	The endpoint for fetching user info.
token_url	string	The endpoint for obtaining auth token.
auth_url	string	The endpoint for authorization request flow.
logout_url	string	The endpoint used to redirect after sign-out.
label	string	Human-readable identity provider is label.
management_url	string	The endpoint for user details management.
protected_fields	any
extra_scope	string	Space-separated list of scopes to request during authentication.
user_field	string	The field in Waldur User model to be used for looking up the user
user_claim	string	The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any	A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string	Space-separated list of extra fields to persist.

---

Partial Update

HTTPiePythonTypeScriptPath ParametersRequest BodyResponses

http \
  PATCH \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_identity_provider_request import PatchedIdentityProviderRequest # (1)
from waldur_api_client.api.identity_providers import identity_providers_partial_update # (2)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)

body_data = PatchedIdentityProviderRequest()
response = identity_providers_partial_update.sync(
    provider="string-value",
    client=client,
    body=body_data
)

print(response)

1. Model Source: PatchedIdentityProviderRequest
2. API Source: identity_providers_partial_update

import { identityProvidersPartialUpdate } from 'waldur-js-client';

try {
  const response = await identityProvidersPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
provider	string	✓

Field	Type	Required	Description
provider	string
is_active	boolean
client_id	string		ID of application used for OAuth authentication.
client_secret	string		Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string		The endpoint for endpoint discovery.
label	string		Human-readable identity provider is label.
management_url	string		The endpoint for user details management.
protected_fields	any
extra_scope	string		Space-separated list of scopes to request during authentication.
user_field	string		The field in Waldur User model to be used for looking up the user
user_claim	string		The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any		A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string		Space-separated list of extra fields to persist.

200 -

Field	Type	Description
provider	string
is_active	boolean
client_id	string	ID of application used for OAuth authentication.
client_secret	string	Application secret key.
verify_ssl	boolean
enable_post_logout_redirect	boolean
enable_pkce	boolean
discovery_url	string	The endpoint for endpoint discovery.
userinfo_url	string	The endpoint for fetching user info.
token_url	string	The endpoint for obtaining auth token.
auth_url	string	The endpoint for authorization request flow.
logout_url	string	The endpoint used to redirect after sign-out.
label	string	Human-readable identity provider is label.
management_url	string	The endpoint for user details management.
protected_fields	any
extra_scope	string	Space-separated list of scopes to request during authentication.
user_field	string	The field in Waldur User model to be used for looking up the user
user_claim	string	The OIDC claim from the userinfo endpoint to be used as the value for the lookup field.
attribute_mapping	any	A JSON object mapping Waldur User model fields to OIDC claims. Example:
extra_fields	string	Space-separated list of extra fields to persist.

---

Delete

HTTPiePythonTypeScriptPath ParametersResponses

http \
  DELETE \
  https://api.example.com/api/identity-providers/string-value/ \
  Authorization:"Token YOUR_API_TOKEN"

from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.identity_providers import identity_providers_destroy # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = identity_providers_destroy.sync(
    provider="string-value",
    client=client
)

print(response)

1. API Source: identity_providers_destroy

import { identityProvidersDestroy } from 'waldur-js-client';

try {
  const response = await identityProvidersDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "provider": "string-value"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}

Name	Type	Required
provider	string	✓

204 - No response body

---