okapi/okapi-onboarding.proto

syntax = "proto3";
option go_package = "whiteboxsystems.nl/okapi";

enum XISAuthMethod {
	mTLS = 0;
	BearerToken = 1;
}

message MTLSConfigurationParams {
	string publicKey = 1;
}

message BearerTokenConfigurationParams {
	string token = 1;
}

message XISAuthConfiguration {
	XISAuthMethod method = 1;
	oneof configuration {
		MTLSConfigurationParams mtlsConfiguration = 2;
		BearerTokenConfigurationParams apiTokenConfiguration = 3;
	}
}

message GetMetadataRequest {}

message GetMetadataResponse {
	string supplierFormalName = 1;
	string supplierDisplayName = 2;
	string productName = 3;
	string version = 4;
}

message RegisterRequest {
	string organisationFormalName = 1;
	string organisationDisplayName = 2;
	string organisationIdentifier = 3;
	string organisationIdentifierType = 4; // Type bijv. AGB, BIG registratie of KvK
	XISAuthConfiguration auth = 5;
}

message RegisterResponse {
	string reference = 1;
}

message CompleteRegistrationRequest {
	string reference = 1;
	string authorisationToken = 2;
}

message CompleteRegistrationResponse {}