Skip to content

Auth Valimo

Operations Summary

Method Endpoint Description
Core CRUD
POST /api/auth-valimo/ Create
Other Actions
POST /api/auth-valimo/result/ Result

Core CRUD

Create

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/auth-valimo/ \
  Authorization:"Token YOUR_API_TOKEN" \
  phone="+1-202-555-0104"

 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.auth_result_request import AuthResultRequest # (1)
from waldur_api_client.api.auth_valimo import auth_valimo_create # (2)

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

body_data = AuthResultRequest(
    phone="+1-202-555-0104"
)
response = auth_valimo_create.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await authValimoCreate({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "phone": "+1-202-555-0104"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required
phone string ✓

201 -

Field Type Description
uuid string (uuid)
token string
phone string
message string This message will be shown to user.
state any
error_message string
details string Cancellation details.

Other Actions

Result

1
2
3
4
5
6
7
8
9
    To get PKI login status and details - issue post request against /api/auth-valimo/result/
    with uuid in parameters.

    Possible states:
     - Scheduled - login process is scheduled
     - Processing - login is in progress
     - OK - login was successful. Response will contain token.
     - Canceled - login was canceled by user or timed out. Field details will contain additional info.
     - Erred - unexpected exception happened during login process.

1
2
3
4
5
http \
  POST \
  https://api.example.com/api/auth-valimo/result/ \
  Authorization:"Token YOUR_API_TOKEN" \
  uuid="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.auth_result_uuid_request import AuthResultUUIDRequest # (1)
from waldur_api_client.api.auth_valimo import auth_valimo_result # (2)

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

body_data = AuthResultUUIDRequest(
    uuid="a1b2c3d4-e5f6-7890-abcd-ef1234567890"
)
response = auth_valimo_result.sync(
    client=client,
    body=body_data
)

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

try {
  const response = await authValimoResult({
  auth: "Token YOUR_API_TOKEN",
  body: {
    "uuid": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  }
});
  console.log('Success:', response);
} catch (error) {
  console.error('Error:', error);
}
Field Type Required Description
uuid string (uuid) ✓ UUID of the authentication result.

200 -

Field Type Description
uuid string (uuid)
token string
phone string
message string This message will be shown to user.
state any
error_message string
details string Cancellation details.