Skip to content

Freeipa Profiles

Operations Summary

Method Endpoint Description
GET /api/freeipa-profiles/ List Freeipa Profiles
GET /api/freeipa-profiles/{uuid}/ Retrieve
POST /api/freeipa-profiles/ Create
POST /api/freeipa-profiles/{uuid}/update_ssh_keys/ Update SSH keys for profile
PUT /api/freeipa-profiles/{uuid}/ Update
PATCH /api/freeipa-profiles/{uuid}/ Partial Update

List Freeipa Profiles

1
2
3
4
http \
  GET \
  https://api.example.com/api/freeipa-profiles/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_list # (1)

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

for item in response:
    print(item)
  1. API Source: freeipa_profiles_list
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
import { freeipaProfilesList } from 'waldur-js-client';

try {
  const response = await freeipaProfilesList({
  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.
query string Filter by username, user UUID, first name or last name
user string (uuid)

200 -

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

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_retrieve # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_retrieve.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_retrieve
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesRetrieve } from 'waldur-js-client';

try {
  const response = await freeipaProfilesRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/freeipa-profiles/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.freeipa_profile_request import FreeipaProfileRequest # (1)
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_create # (2)

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

body_data = FreeipaProfileRequest(
    username="alice"
)
response = freeipa_profiles_create.sync(
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FreeipaProfileRequest
  2. API Source: freeipa_profiles_create
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesCreate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
username string ✓ Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.

201 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Update SSH keys for profile

Update SSH keys for profile.

1
2
3
4
http \
  POST \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/update_ssh_keys/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_update_ssh_keys # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_update_ssh_keys.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_update_ssh_keys
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesUpdateSshKeys } from 'waldur-js-client';

try {
  const response = await freeipaProfilesUpdateSshKeys({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 - No response body

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN" \
  username="alice"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.freeipa_profile_request import FreeipaProfileRequest # (1)
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_update # (2)

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

body_data = FreeipaProfileRequest(
    username="alice"
)
response = freeipa_profiles_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client,
    body=body_data
)

print(response)
  1. Model Source: FreeipaProfileRequest
  2. API Source: freeipa_profiles_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
import { freeipaProfilesUpdate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  body: {
    "username": "alice"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓
Field Type Required Description
username string ✓ Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/freeipa-profiles/a1b2c3d4-e5f6-7890-abcd-ef1234567890/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.freeipa_profiles import freeipa_profiles_partial_update # (1)

client = AuthenticatedClient(
    base_url="https://api.example.com", token="YOUR_API_TOKEN"
)
response = freeipa_profiles_partial_update.sync(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    client=client
)

print(response)
  1. API Source: freeipa_profiles_partial_update
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
import { freeipaProfilesPartialUpdate } from 'waldur-js-client';

try {
  const response = await freeipaProfilesPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
uuid string (uuid) ✓

200 -

Field Type Description
uuid string (uuid)
username string Letters, numbers and ./+/-/_ characters
agreement_date string (date-time) Indicates when the user has agreed with the policy.
is_active boolean
user string (uri)
user_uuid string (uuid)
user_username string Required. 128 characters or fewer. Lowercase letters, numbers and @/./+/-/_ characters
user_full_name string