Skip to content

Accounts (2.0.0)

The 'Accounts' 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

Subtenantcontractconnection

Operations

Subtenanttenantconnection

Operations

Tenant

Operations

Organizationuser

Operations

Delete 'Organizationuser'

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 DELETE \
  'https://dev.api.pigello.io/accounts/users/organization/organizationuser/{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 deletion

Response
No content

Update 'Organizationuser'

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
detail_accessinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
custom_idstring or null<= 128 characters
external_clientsArray of objects(Externalclient)
ssn_is_coordination_numberboolean
debt_distribution_instructionArray of objects or null
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
reminder_distribution_instructionArray of objects or null
org_nostring or null(luhn)[ 10 .. 11 ] characters
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

organizationobject or null(Organization)
anonymizedboolean
fmistring or null[ 17 .. 20 ] characters
roleobject or null(Role)
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
prefer_invoice_view_onlyboolean
first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_distribution_instructionArray of objects or null
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

is_activeboolean
anonymization_namestring or null<= 255 characters
profile_pictureobject or null
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounts/users/organization/organizationuser/{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 '{
    "custom_id": "string",
    "external_clients": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
      }
    ],
    "ssn_is_coordination_number": true,
    "debt_distribution_instruction": [
      null
    ],
    "birth_date": "2019-08-24",
    "email": "user@example.com",
    "reminder_distribution_instruction": [
      null
    ],
    "org_no": "stringstri",
    "last_name": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "anonymized": true,
    "fmi": "stringstringstrin",
    "detail_access": 0,
    "role": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "send_out_distribution_instruction": [
      null
    ],
    "active_to": "2019-08-24T14:15:22Z",
    "prefer_invoice_view_only": true,
    "first_name": "string",
    "phone_number": "string",
    "ssn": "stringstring",
    "invoice_distribution_instruction": [
      null
    ],
    "corporate_name": "string",
    "is_active": true,
    "anonymization_name": "string",
    "profile_picture": {
      "name": "string",
      "md5_hash": "string",
      "get": "string",
      "post": {
        "url": "string",
        "fields": {}
      }
    }
  }'

Responses

Successful update

Bodyapplication/json
detail_accessinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

mfa_has_totpboolean or nullread-only
custom_idstring or null<= 128 characters
external_clientsArray of objects(Externalclient)
ssn_is_coordination_numberboolean
debt_distribution_instructionArray of objects or null
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
email_verifiedbooleanread-only
reminder_distribution_instructionArray of objects or null
full_nameanyread-only
tagsanyread-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

last_loginstring or null(date-time)read-only
organizationobject or null(Organization)
communication_nameanyread-only
anonymizedboolean
fmistring or null[ 17 .. 20 ] characters
customer_columnsanyread-only
roleobject or null(Role)
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

prefer_invoice_view_onlyboolean
first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
mfa_has_hotpboolean or nullread-only
hotp_invite_sendout_timestring or null(date-time)read-only
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_distribution_instructionArray of objects or null
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

is_activeboolean
created_atstring(date-time)read-only
anonymization_namestring or null<= 255 characters
profile_pictureobject or null
phone_number_verifiedbooleanread-only
Response
application/json
{
  "mfa_has_totp": true,
  "custom_id": "string",
  "external_clients": [
    { … }
  ],
  "ssn_is_coordination_number": true,
  "debt_distribution_instruction": [
    null
  ],
  "birth_date": "2019-08-24",
  "email": "user@example.com",
  "email_verified": true,
  "reminder_distribution_instruction": [
    null
  ],
  "full_name": null,
  "tags": null,
  "org_no": "stringstri",
  "last_name": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "communication_name": null,
  "anonymized": true,
  "fmi": "stringstringstrin",
  "customer_columns": null,
  "detail_access": 0,
  "role": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "send_out_distribution_instruction": [
    null
  ],
  "active_to": "2019-08-24T14:15:22Z",
  "username": "stringst",
  "prefer_invoice_view_only": true,
  "first_name": "string",
  "phone_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "mfa_has_hotp": true,
  "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
  "ssn": "stringstring",
  "invoice_distribution_instruction": [
    null
  ],
  "corporate_name": "string",
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "anonymization_name": "string",
  "profile_picture": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "phone_number_verified": true
}

Get 'Organizationuser'

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/accounts/users/organization/organizationuser/{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
detail_accessinteger(int32)[ -2147483648 .. 2147483647 ]required
Enum012
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

mfa_has_totpboolean or nullread-only
custom_idstring or null<= 128 characters
external_clientsArray of objects(Externalclient)
ssn_is_coordination_numberboolean
debt_distribution_instructionArray of objects or null
birth_datestring or null(date)
emailstring or null(email)<= 254 characters
email_verifiedbooleanread-only
reminder_distribution_instructionArray of objects or null
full_nameanyread-only
tagsanyread-only
org_nostring or null(luhn)[ 10 .. 11 ] characters
last_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, corporate_name

last_loginstring or null(date-time)read-only
organizationobject or null(Organization)
communication_nameanyread-only
anonymizedboolean
fmistring or null[ 17 .. 20 ] characters
customer_columnsanyread-only
roleobject or null(Role)
send_out_distribution_instructionArray of objects or null
active_tostring or null(date-time)
usernamestring or null[ 8 .. 150 ] characters'^[\w.@+-]+\Z'read-only

Additional Validation Information:

Must be unique

prefer_invoice_view_onlyboolean
first_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: last_name, corporate_name

phone_numberstring or null<= 36 characters'^\+?1?\d{7,15}$'
mfa_has_hotpboolean or nullread-only
hotp_invite_sendout_timestring or null(date-time)read-only
ssnstring or null(luhn)[ 12 .. 13 ] characters
invoice_distribution_instructionArray of objects or null
corporate_namestring or null<= 255 characters

Additional Validation Information:

This field, or at least one of the following fields must be set: first_name, last_name

is_activeboolean
created_atstring(date-time)read-only
anonymization_namestring or null<= 255 characters
profile_pictureobject or null
phone_number_verifiedbooleanread-only
Response
application/json
{
  "mfa_has_totp": true,
  "custom_id": "string",
  "external_clients": [
    { … }
  ],
  "ssn_is_coordination_number": true,
  "debt_distribution_instruction": [
    null
  ],
  "birth_date": "2019-08-24",
  "email": "user@example.com",
  "email_verified": true,
  "reminder_distribution_instruction": [
    null
  ],
  "full_name": null,
  "tags": null,
  "org_no": "stringstri",
  "last_name": "string",
  "last_login": "2019-08-24T14:15:22Z",
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "communication_name": null,
  "anonymized": true,
  "fmi": "stringstringstrin",
  "customer_columns": null,
  "detail_access": 0,
  "role": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "send_out_distribution_instruction": [
    null
  ],
  "active_to": "2019-08-24T14:15:22Z",
  "username": "stringst",
  "prefer_invoice_view_only": true,
  "first_name": "string",
  "phone_number": "string",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "mfa_has_hotp": true,
  "hotp_invite_sendout_time": "2019-08-24T14:15:22Z",
  "ssn": "stringstring",
  "invoice_distribution_instruction": [
    null
  ],
  "corporate_name": "string",
  "is_active": true,
  "created_at": "2019-08-24T14:15:22Z",
  "anonymization_name": "string",
  "profile_picture": {
    "name": "string",
    "md5_hash": "string",
    "get": "string",
    "post": { … }
  },
  "phone_number_verified": true
}

Subtenant

Operations

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.