README

EU Access Users API

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new EC\EUAccess\Client\Api\AttributesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);
$request = new \EC\EUAccess\Client\Model\AttributeCreateRequest(); // \EC\EUAccess\Client\Model\AttributeCreateRequest | Attribute object

try {
    $result = $apiInstance->createAttributeValue($request);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AttributesApi->createAttributeValue: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://eu-access-admin-int-host:14222/eu-access/admin-int/usersData

Class	Method	HTTP request	Description
AttributesApi	createAttributeValue	POST /v1.0/attributes	Create a new attribute for the user identity
AttributesApi	deleteAttributeValue	DELETE /v1.0/attributes/{attributeId}	Deletes an attribute profile
AttributesApi	getAttributeKeyList	GET /v1.0/attributes/keys	Get the attributes business codes
AttributesApi	getAttributeValue	GET /v1.0/attributes/{attributeId}	Get the attribute with the given id
AttributesApi	getAttributes	GET /v1.0/attributes	Get all attributes for an user identity
AttributesApi	updateAttributeValue	PUT /v1.0/attributes/{attributeId}	Update the attribute value with the given id
IdentitiesApi	createUserIdentity	POST /v1.0/identities	Create an identity for the actor
IdentitiesApi	deleteIdentity	DELETE /v1.0/identities/{identityId}	Deletes an identity
IdentitiesApi	getUserIdentities	GET /v1.0/identities	Get user identities
IdentitiesApi	getUserIdentity	GET /v1.0/identities/{identityId}	Get the details of the user identity
ProfileAssignmentsApi	createProfileAssignment	POST /v1.0/profileAssignments	Create a profile assignment for an identity
ProfileAssignmentsApi	deleteProfileAssignment	DELETE /v1.0/profileAssignments/{profileAssignmentId}	Deletes a profile assignment
ProfileAssignmentsApi	getProfileAssignment	GET /v1.0/profileAssignments/{profileAssignmentId}	Get the profile assignment with the given id
ProfileAssignmentsApi	getProfileAssignments	GET /v1.0/profileAssignments	Get profile assignments for the given identity id
ProfileAssignmentsApi	updateProfileAssignment	PUT /v1.0/profileAssignments/{profileAssignmentId}	Update a profile assignment with the given id
UsersApi	createNaturalUser	POST /v1.0/users	Create an user as natural person
UsersApi	getListOfUsers	GET /v1.0/users	Get list of users

Models

Authorization

All endpoints do not require authorization.

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

DIGIT-EU-ACCESS@ec.europa.eu

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

ec / eu-access-client

Maintainers

Details