Id Service 1.0.0 documentation

Id Service

Operations

PUB *.*.permissions.synchronize Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message synchronize-permissions-command

• Message ID: synchronize-permissions-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Synchronize permissions command schema	-	-	additional properties are NOT allowed
service_id	string	ID of the service the permissions will be synchronized for.	-	-	required
permissions	array<object>	Permissions to be synchronized	-	-	required
permissions.key	string	Permission Key	-	-	required
permissions.title	string	Permission Title	-	-	required
permissions.used_by_managed_service_only	boolean	Managed Service Only Permission	-	-	-
permissions.used_for_development	boolean	Used for Development Only	-	-	-
permissions.gql_operations	array<string>	GQL Operations mapped to the Permission	-	-	-
permissions.gql_operations (single item)	string	-	-	-	-

Examples of payload (generated)

{
  "service_id": "string",
  "permissions": [
    {
      "key": "string",
      "title": "string",
      "used_by_managed_service_only": true,
      "used_for_development": true,
      "gql_operations": [
        "string"
      ]
    }
  ]
}

Message tags

Name	Description	Documentation
aggregate-type:permission	-	-
aggregate-id-field:environment ID	-	-

PUB *.*.user.delete Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message delete-user-command

• Message ID: delete-user-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Command schema to issue deleting of a single user by id.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:user	-	-
aggregate-id-field:user ID	-	-

PUB *.*.service_account.delete Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message delete-service-account-command

• Message ID: delete-service-account-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Command schema to issue deleting of a single service account by id.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:service-account	-	-
aggregate-id-field:client ID	-	-

PUB *.*.user_role.delete Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message delete-user-role-command

• Message ID: delete-user-role-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Command schema to issue deleting of a single user role by id.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:user-role	-	-
aggregate-id-field:user role ID	-	-

PUB id_service.enable Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message id-service-enable-command

• Message ID: id-service-enable-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service enable command schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
config	object	ID Service config defaults	-	-	additional properties are NOT allowed
config.management_super_admins	array<string>	List of management super admins	-	-	-
config.management_super_admins (single item)	string	-	-	-	-
config.allowed_origins	array<string>	List of allowed origins	-	-	-
config.allowed_origins (single item)	string	-	-	-	-
config.access_token_lifetime	integer	Access token lifetime in seconds	-	-	-
config.cookie_lifetime	integer	Cookie lifetime in seconds	-	-	-
config.service_account_token_lifetime	integer	Service account token lifetime in seconds	-	-	-
config.idp_configurations	object	Configuration details for ID Providers	-	-	additional properties are NOT allowed
config.idp_configurations.google	object	IDP configuration for Google	-	-	additional properties are NOT allowed
config.idp_configurations.google.enabled	boolean	Status of the IDP	-	-	required
config.idp_configurations.google.use_built_in_idp	boolean	Use built in Google IDP	-	-	required
config.idp_configurations.google.client_id	string	Client ID for Google IDP	-	-	-
config.idp_configurations.google.client_secret	string	Client secret for Google IDP	-	-	-
config.idp_configurations.google (if)	-	-	-	-	-
config.idp_configurations.google.use_built_in_idp	boolean	Use built in Google IDP	-	-	additional properties are allowed
config.idp_configurations.google (then)	-	-	-	-	-
config.idp_configurations.axinom	object	IDP configuration for Axinom	-	-	additional properties are NOT allowed
config.idp_configurations.axinom.enabled	boolean	Status of the IDP	-	-	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "config": {
    "management_super_admins": [
      "string"
    ],
    "allowed_origins": [
      "string"
    ],
    "access_token_lifetime": 0,
    "cookie_lifetime": 0,
    "service_account_token_lifetime": 0,
    "idp_configurations": {
      "google": {
        "enabled": true,
        "use_built_in_idp": false,
        "client_id": "string",
        "client_secret": "string"
      },
      "axinom": {
        "enabled": true
      }
    }
  }
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-

PUB id_service.disable Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"inbox"	-	-

Message id-service-disable-command

• Message ID: id-service-disable-command
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service disable command schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-

SUB *.*.permissions.synchronize_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"permissions:synchronize_finished"	-	-

Message synchronize-permissions-finished-event

• Message ID: synchronize-permissions-finished-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Synchronize permissions finished event schema	-	-	additional properties are NOT allowed
service_id	string	ID of the service permissions synchronized for.	-	-	required
permissions_stored	array<string>	Newly added permissions	-	-	required
permissions_stored (single item)	string	-	-	-	-
permissions_removed	array<string>	Removed permissions	-	-	required
permissions_removed (single item)	string	-	-	-	-

Examples of payload (generated)

{
  "service_id": "string",
  "permissions_stored": [
    "string"
  ],
  "permissions_removed": [
    "string"
  ]
}

Message tags

Name	Description	Documentation
aggregate-type:permission	-	-
aggregate-id-field:environment ID	-	-

SUB *.*.permissions.synchronize_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"permissions:synchronize_failed"	-	-

Message synchronize-permissions-failed-event

• Message ID: synchronize-permissions-failed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Synchronize permissions failed event schema	-	-	additional properties are NOT allowed
service_id	string	ID of the service permissions synchronized for.	-	-	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "service_id": "string",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:permission	-	-
aggregate-id-field:environment ID	-	-

SUB *.*.management_user.delete_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"management_user:delete_finished"	-	-

Message user-delete-finished-event

• Message ID: user-delete-finished-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A User delete finished as part of a background job schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:user	-	-
aggregate-id-field:user ID	-	-

SUB *.*.management_user.delete_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"management_user:delete_failed"	-	-

Message user-delete-failed-event

• Message ID: user-delete-failed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A User delete failed event schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:user	-	-
aggregate-id-field:user ID	-	-

SUB *.*.management_user_role.delete_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"management_user_role:delete_finished"	-	-

Message user-role-delete-finished-event

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A User Role delete finished as part of a background job schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:user-role	-	-
aggregate-id-field:user role ID	-	-

SUB *.*.management_user_role.delete_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"management_user_role:delete_failed"	-	-

Message user-role-delete-failed-event

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A User Role delete failed event schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:user-role	-	-
aggregate-id-field:user role ID	-	-

SUB *.*.management_user_role.assignment_changed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"management_user_role:assignment_changed"	-	-

Message user-role-assignment-changed-event

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A User Role is either assigned or unassigned from a User.	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	-
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	-
user_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
user_role_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
user_role_name	string	User Role Name	-	-	required
change_type	string	Represents if the User Role was assigned or unassigned from the User.	allowed ("USER_ROLE_ASSIGNED", "USER_ROLE_UNASSIGNED")	-	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",
  "user_role_id": "1e7e45a3-9003-4195-97ed-60c09c31207c",
  "user_role_name": "string",
  "change_type": "USER_ROLE_ASSIGNED"
}

Message tags

Name	Description	Documentation
aggregate-type:user-role-assignment	-	-
aggregate-id-field:user role assignment ID	-	-

SUB *.*.service_account.delete_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"service_account:delete_finished"	-	-

Message service-account-delete-finished-event

• Message ID: service-account-delete-finished-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A Service Account delete finished as part of a background job schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165"
}

Message tags

Name	Description	Documentation
aggregate-type:service-account	-	-
aggregate-id-field:client ID	-	-

SUB *.*.service_account.delete_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"service_account:delete_failed"	-	-

Message service-account-delete-failed-event

• Message ID: service-account-delete-failed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	A Service Account delete failed event schema.	-	-	additional properties are NOT allowed
entity_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "entity_id": "8161163a-f227-466f-bc01-090a01e80165",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:service-account	-	-
aggregate-id-field:client ID	-	-

SUB *.*.service_account.permission_changed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"service_account:permission_changed"	-	-

Message service-account-permission-changed-event

• Message ID: service-account-permission-changed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	Schema for an event that occurs when a service account permission changes. This event is emitted when a service account permission is added or removed.	-	-	additional properties are NOT allowed
client_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643"
}

Message tags

Name	Description	Documentation
aggregate-type:service-account	-	-
aggregate-id-field:client ID	-	-

SUB id_service.enable_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"id_service:enable_finished"	-	-

Message id-service-enable-finished-event

• Message ID: id-service-enable-finished-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service enable finished event schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-

SUB id_service.enable_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"id_service:enable_failed"	-	-

Message id-service-enable-failed-event

• Message ID: id-service-enable-failed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service enable failed event schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-

SUB id_service.disable_finished Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"id_service:disable_finished"	-	-

Message id-service-disable-finished-event

• Message ID: id-service-disable-finished-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service disable finished event schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4"
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-

SUB id_service.disable_failed Operation

amqp Channel specific information

Name	Type	Description	Value	Constraints	Notes
queue	-	-	-	-	-
queue.name	-	-	"id_service:disable_failed"	-	-

Message id-service-disable-failed-event

• Message ID: id-service-disable-failed-event
• Content type: application/json

Payload

Name	Type	Description	Value	Constraints	Notes
(root)	object	ID Service disable failed event schema	-	-	additional properties are NOT allowed
tenant_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
environment_id	string	A UUID.	-	format (uuid), [ 32 .. 36 ] characters	required
error_message	string	Error message	-	-	required

Examples of payload (generated)

{
  "tenant_id": "34f5c98e-f430-457b-a812-92637d0c6fd0",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "error_message": "string"
}

Message tags

Name	Description	Documentation
aggregate-type:environment	-	-
aggregate-id-field:environment ID	-	-