Skip to content
/
Create 'Securityconfigura...

Configurations (2.0.0)

The 'Configurations' application of the Core API

Download OpenAPI description
Download Postman Collection
Download OpenAPI Specification (json)
Download OpenAPI Specification (yaml)
Languages
Servers
https://{environment}.pigello.io

Commonorganizationsettings

Operations

Validationconfiguration

Operations

Automationconfiguration

Operations

Customercommunicationconfiguration

Operations

Securityconfiguration

Operations

Update 'Securityconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
Bodyapplication/json
customers_can_use_bankid_loginboolean
require_mfa_for_customersboolean
customers_can_use_hotp_loginboolean
password_expiration_daysinteger or null(int32)[ 14 .. 2147483647 ]
non_customers_can_use_bankid_loginboolean
non_customers_can_use_hotp_loginboolean
custom_idstring or null<= 128 characters
require_mfa_for_non_customersboolean
organizationobject or null(Organization)
approved_non_customer_hotp_email_domainsArray of strings or null
curl -i -X PATCH \
  'https://dev.api.pigello.io/configurations/securityconfiguration/{pk}/' \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "customers_can_use_bankid_login": true,
    "require_mfa_for_customers": true,
    "customers_can_use_hotp_login": true,
    "password_expiration_days": 14,
    "non_customers_can_use_bankid_login": true,
    "non_customers_can_use_hotp_login": true,
    "custom_id": "string",
    "require_mfa_for_non_customers": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "approved_non_customer_hotp_email_domains": [
      "string"
    ]
  }'

Responses

Successful update

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

customers_can_use_bankid_loginboolean
require_mfa_for_customersboolean
customers_can_use_hotp_loginboolean
password_expiration_daysinteger or null(int32)[ 14 .. 2147483647 ]
non_customers_can_use_bankid_loginboolean
non_customers_can_use_hotp_loginboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
require_mfa_for_non_customersboolean
organizationobject or null(Organization)
approved_non_customer_hotp_email_domainsArray of strings or null
Response
application/json
{
  "customers_can_use_bankid_login": true,
  "require_mfa_for_customers": true,
  "customers_can_use_hotp_login": true,
  "password_expiration_days": 14,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "non_customers_can_use_bankid_login": true,
  "non_customers_can_use_hotp_login": true,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "require_mfa_for_non_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "approved_non_customer_hotp_email_domains": [
    "string"
  ]
}

Get 'Securityconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Path
pkstringwrite-onlyrequired
curl -i -X GET \
  'https://dev.api.pigello.io/configurations/securityconfiguration/{pk}/' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE'

Responses

Successful selection

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

customers_can_use_bankid_loginboolean
require_mfa_for_customersboolean
customers_can_use_hotp_loginboolean
password_expiration_daysinteger or null(int32)[ 14 .. 2147483647 ]
non_customers_can_use_bankid_loginboolean
non_customers_can_use_hotp_loginboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
require_mfa_for_non_customersboolean
organizationobject or null(Organization)
approved_non_customer_hotp_email_domainsArray of strings or null
Response
application/json
{
  "customers_can_use_bankid_login": true,
  "require_mfa_for_customers": true,
  "customers_can_use_hotp_login": true,
  "password_expiration_days": 14,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "non_customers_can_use_bankid_login": true,
  "non_customers_can_use_hotp_login": true,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "require_mfa_for_non_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "approved_non_customer_hotp_email_domains": [
    "string"
  ]
}

Create 'Securityconfiguration'

Request

Security
customer_id and application_id and service_id and service_version_id and client_ct and client_object_id and client_secret
Bodyapplication/json
customers_can_use_bankid_loginboolean
require_mfa_for_customersboolean
customers_can_use_hotp_loginboolean
password_expiration_daysinteger or null(int32)[ 14 .. 2147483647 ]
non_customers_can_use_bankid_loginboolean
non_customers_can_use_hotp_loginboolean
custom_idstring or null<= 128 characters
require_mfa_for_non_customersboolean
organizationobject or null(Organization)
approved_non_customer_hotp_email_domainsArray of strings or null
curl -i -X POST \
  https://dev.api.pigello.io/configurations/securityconfiguration/ \
  -H 'Content-Type: application/json' \
  -H 'X-PIGELLO-APPLICATION-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-CT: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-ENTITY: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CLIENT-SECRET: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-CUSTOMER-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-ID: YOUR_API_KEY_HERE' \
  -H 'X-PIGELLO-SERVICE-VERSION-ID: YOUR_API_KEY_HERE' \
  -d '{
    "customers_can_use_bankid_login": true,
    "require_mfa_for_customers": true,
    "customers_can_use_hotp_login": true,
    "password_expiration_days": 14,
    "non_customers_can_use_bankid_login": true,
    "non_customers_can_use_hotp_login": true,
    "custom_id": "string",
    "require_mfa_for_non_customers": true,
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "approved_non_customer_hotp_email_domains": [
      "string"
    ]
  }'

Responses

Successful creation

Bodyapplication/json
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

customers_can_use_bankid_loginboolean
require_mfa_for_customersboolean
customers_can_use_hotp_loginboolean
password_expiration_daysinteger or null(int32)[ 14 .. 2147483647 ]
non_customers_can_use_bankid_loginboolean
non_customers_can_use_hotp_loginboolean
created_atstring(date-time)read-only
custom_idstring or null<= 128 characters
require_mfa_for_non_customersboolean
organizationobject or null(Organization)
approved_non_customer_hotp_email_domainsArray of strings or null
Response
application/json
{
  "customers_can_use_bankid_login": true,
  "require_mfa_for_customers": true,
  "customers_can_use_hotp_login": true,
  "password_expiration_days": 14,
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "non_customers_can_use_bankid_login": true,
  "non_customers_can_use_hotp_login": true,
  "created_at": "2019-08-24T14:15:22Z",
  "custom_id": "string",
  "require_mfa_for_non_customers": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "approved_non_customer_hotp_email_domains": [
    "string"
  ]
}

Retroactivityconfiguration

Operations
© Pigello. All rights reserved.