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

Subtenant

Operations

Organizationuserworkengagement

Operations

Organizationusersegment

Operations

Integrationuseragent

Operations

Get 'Integrationuseragent'

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/api/integrationuseragent/{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
subscribes_to_eventsArray of objectsread-onlyrequired
requires_sole_category_ownershipbooleanread-onlyrequired
allowed_accessobjectread-onlyrequired
allowed_access.​property name*anyadditional property
allow_token_generation_for_tenantsbooleanread-onlyrequired
service_idstring(uuid)required
clashing_priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
allow_token_generation_for_sub_tenantsbooleanread-onlyrequired
service_version_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

require_personal_information_accessbooleanread-onlyrequired
application_idstring(uuid)required
has_sub_tenant_http_invokable_methodbooleanread-onlyrequired
has_tenant_http_invokable_methodbooleanread-onlyrequired
registered_ip_addressesArray of strings or nulluniqueread-only
activation_variablesobject or null
integration_activation_dataobject or null
activation_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: activation_content_type

created_atstring(date-time)read-only
activation_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: activation_object_id

is_activeboolean
categorystring or null
access_requires_specific_object_connectionboolean
personal_information_acceptance_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "registered_ip_addresses": [
    "string"
  ],
  "subscribes_to_events": [
    null
  ],
  "requires_sole_category_ownership": true,
  "allowed_access": {},
  "allow_token_generation_for_tenants": true,
  "activation_variables": {},
  "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  "integration_activation_data": {},
  "activation_object_id": "c5a56fe5-88a3-45fb-b8be-0179e3e35fc6",
  "clashing_priority": -2147483648,
  "allow_token_generation_for_sub_tenants": true,
  "created_at": "2019-08-24T14:15:22Z",
  "service_version_id": "26d5aff9-394f-4ac9-b146-a5dbfb7218eb",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "activation_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_active": true,
  "category": "string",
  "access_requires_specific_object_connection": true,
  "personal_information_acceptance_mode": 0,
  "custom_id": "string",
  "require_personal_information_access": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  "has_sub_tenant_http_invokable_method": true,
  "has_tenant_http_invokable_method": true
}

Delete 'Integrationuseragent'

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/api/integrationuseragent/{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 'Integrationuseragent'

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
service_idstring(uuid)required
clashing_priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
service_version_idstring(uuid)required
application_idstring(uuid)required
activation_variablesobject or null
integration_activation_dataobject or null
activation_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: activation_content_type

activation_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: activation_object_id

is_activeboolean
categorystring or null
access_requires_specific_object_connectionboolean
personal_information_acceptance_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
curl -i -X PATCH \
  'https://dev.api.pigello.io/accounts/users/api/integrationuseragent/{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 '{
    "activation_variables": {},
    "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
    "integration_activation_data": {},
    "activation_object_id": "c5a56fe5-88a3-45fb-b8be-0179e3e35fc6",
    "clashing_priority": -2147483648,
    "service_version_id": "26d5aff9-394f-4ac9-b146-a5dbfb7218eb",
    "activation_content_type": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "is_active": true,
    "category": "string",
    "access_requires_specific_object_connection": true,
    "personal_information_acceptance_mode": 0,
    "custom_id": "string",
    "organization": {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    },
    "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c"
  }'

Responses

Successful update

Bodyapplication/json
subscribes_to_eventsArray of objectsread-onlyrequired
requires_sole_category_ownershipbooleanread-onlyrequired
allowed_accessobjectread-onlyrequired
allowed_access.​property name*anyadditional property
allow_token_generation_for_tenantsbooleanread-onlyrequired
service_idstring(uuid)required
clashing_priorityinteger(int32)[ -2147483648 .. 2147483647 ]required
allow_token_generation_for_sub_tenantsbooleanread-onlyrequired
service_version_idstring(uuid)required
idstring(uuid)read-onlyrequired

Additional Validation Information:

Must be unique

require_personal_information_accessbooleanread-onlyrequired
application_idstring(uuid)required
has_sub_tenant_http_invokable_methodbooleanread-onlyrequired
has_tenant_http_invokable_methodbooleanread-onlyrequired
registered_ip_addressesArray of strings or nulluniqueread-only
activation_variablesobject or null
integration_activation_dataobject or null
activation_object_idstring or null(uuid)

Additional Validation Information:

This value must be set together with the following fields: activation_content_type

created_atstring(date-time)read-only
activation_content_typeobject or null(Contenttype)

Additional Validation Information:

This value must be set together with the following fields: activation_object_id

is_activeboolean
categorystring or null
access_requires_specific_object_connectionboolean
personal_information_acceptance_modeinteger or null(int32)[ -2147483648 .. 2147483647 ]
Enum012
custom_idstring or null<= 128 characters
organizationobject or null(Organization)
Response
application/json
{
  "registered_ip_addresses": [
    "string"
  ],
  "subscribes_to_events": [
    null
  ],
  "requires_sole_category_ownership": true,
  "allowed_access": {},
  "allow_token_generation_for_tenants": true,
  "activation_variables": {},
  "service_id": "641e839f-864e-4cce-98f9-40f6cbb3e9e0",
  "integration_activation_data": {},
  "activation_object_id": "c5a56fe5-88a3-45fb-b8be-0179e3e35fc6",
  "clashing_priority": -2147483648,
  "allow_token_generation_for_sub_tenants": true,
  "created_at": "2019-08-24T14:15:22Z",
  "service_version_id": "26d5aff9-394f-4ac9-b146-a5dbfb7218eb",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "activation_content_type": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "is_active": true,
  "category": "string",
  "access_requires_specific_object_connection": true,
  "personal_information_acceptance_mode": 0,
  "custom_id": "string",
  "require_personal_information_access": true,
  "organization": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  "application_id": "48ac72d0-a829-4896-a067-dcb1c2b0f30c",
  "has_sub_tenant_http_invokable_method": true,
  "has_tenant_http_invokable_method": true
}

Protectedidentity

Operations

Workengagement

Operations
© Pigello. All rights reserved.