Skip to content

Openportal Userinfo

Operations Summary

Method Endpoint Description
Core CRUD
GET /api/openportal-userinfo/ List Openportal Userinfo
GET /api/openportal-userinfo/{user}/ Retrieve
POST /api/openportal-userinfo/ Create
PUT /api/openportal-userinfo/{user}/ Update
PATCH /api/openportal-userinfo/{user}/ Partial Update
DELETE /api/openportal-userinfo/{user}/ Delete
Other Actions
GET /api/openportal-userinfo/me/ Me
PUT /api/openportal-userinfo/{user}/set_shortname/ Set shortname

Core CRUD

List Openportal Userinfo

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/ \
  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.openportal_userinfo import openportal_userinfo_list # (1)

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

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

try {
  const response = await openportalUserinfoList({
  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.
user string
user_uuid string (uuid)

200 -

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

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Retrieve

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/123/ \
  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.openportal_userinfo import openportal_userinfo_retrieve # (1)

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

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

try {
  const response = await openportalUserinfoRetrieve({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/openportal-userinfo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_create # (2)

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

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await openportalUserinfoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

201 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Update

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_update # (2)

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

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_update.sync(
    user=123,
    client=client,
    body=body_data
)

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

try {
  const response = await openportalUserinfoUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  },
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Partial Update

1
2
3
4
http \
  PATCH \
  https://api.example.com/api/openportal-userinfo/123/ \
  Authorization:"Token YOUR_API_TOKEN"

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.models.patched_user_info_request import PatchedUserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_partial_update # (2)

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

body_data = PatchedUserInfoRequest()
response = openportal_userinfo_partial_update.sync(
    user=123,
    client=client,
    body=body_data
)

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

try {
  const response = await openportalUserinfoPartialUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Delete

1
2
3
4
http \
  DELETE \
  https://api.example.com/api/openportal-userinfo/123/ \
  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.openportal_userinfo import openportal_userinfo_destroy # (1)

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

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

try {
  const response = await openportalUserinfoDestroy({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer ✓

204 - No response body

Other Actions

Me

1
2
3
4
http \
  GET \
  https://api.example.com/api/openportal-userinfo/me/ \
  Authorization:"Token YOUR_API_TOKEN"

1
2
3
4
5
6
7
8
9
from waldur_api_client.client import AuthenticatedClient
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_me_retrieve # (1)

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

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

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

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)

Set shortname

1
2
3
4
5
http \
  PUT \
  https://api.example.com/api/openportal-userinfo/123/set_shortname/ \
  Authorization:"Token YOUR_API_TOKEN" \
  user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"

 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.user_info_request import UserInfoRequest # (1)
from waldur_api_client.api.openportal_userinfo import openportal_userinfo_set_shortname_update # (2)

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

body_data = UserInfoRequest(
    user="https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
)
response = openportal_userinfo_set_shortname_update.sync(
    user=123,
    client=client,
    body=body_data
)

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

try {
  const response = await openportalUserinfoSetShortnameUpdate({
  auth: "Token YOUR_API_TOKEN",
  path: {
    "user": 123
  },
  body: {
    "user": "https://api.example.com/api/user/a1b2c3d4-e5f6-7890-abcd-ef1234567890/"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Name Type Required
user integer ✓
Field Type Required Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri) ✓

200 -

Field Type Description
shortname string A short, unique name for you. It will be used to form your local username on any systems. Should only contain lower-case letters and digits and must start with a letter.
user string (uri)