Skip to content

LoginConfigurationClient

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

LoginConfigurationClient

README.md

login-configuration-client

For more information, please visit https://www.affinidi.com.

Installation & Usage

Requirements

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

Composer

To install the bindings via Composer, run:

composer require affinidi-tdk/affinidi-tdk-php

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/login-configuration-client/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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



// Configure API key authorization: ProjectTokenAuth
$config = AffinidiTdk\Clients\LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKey('authorization', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = AffinidiTdk\Clients\LoginConfigurationClient\Configuration::getDefaultConfiguration()->setApiKeyPrefix('authorization', 'Bearer');


$apiInstance = new AffinidiTdk\Clients\LoginConfigurationClient\Api\AllowListApi(
    // 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(),
    $config
);
$group_names_input = new \AffinidiTdk\Clients\LoginConfigurationClient\Model\GroupNamesInput(); // \AffinidiTdk\Clients\LoginConfigurationClient\Model\GroupNamesInput | List of group names as input

try {
    $apiInstance->allowGroups($group_names_input);
} catch (Exception $e) {
    echo 'Exception when calling AllowListApi->allowGroups: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://apse1.api.affinidi.io/vpa

Class Method HTTP request Description
AllowListApi allowGroups POST /v1/allow-list/groups/add
AllowListApi disallowGroups POST /v1/allow-list/groups/remove
AllowListApi listAllowedGroups GET /v1/allow-list/groups
ConfigurationApi createLoginConfigurations POST /v1/login/configurations Create a new login configuration
ConfigurationApi deleteLoginConfigurationsById DELETE /v1/login/configurations/{configurationId} Delete login configurations by ID
ConfigurationApi getClientMetadataByClientId GET /v1/login/configurations/metadata/{clientId} Get Client Metadata By OAuth 2.0 Client ID
ConfigurationApi getLoginConfigurationsById GET /v1/login/configurations/{configurationId} Get login configuration by ID
ConfigurationApi listLoginConfigurations GET /v1/login/configurations List login configurations
ConfigurationApi updateLoginConfigurationsById PATCH /v1/login/configurations/{configurationId} Update login configurations by ID
DenyListApi blockGroups POST /v1/deny-list/groups/add
DenyListApi blockUsers POST /v1/deny-list/users/add
DenyListApi listBlockedGroups GET /v1/deny-list/groups
DenyListApi listBlockedUsers GET /v1/deny-list/users
DenyListApi unblockGroups POST /v1/deny-list/groups/remove
DenyListApi unblockUsers POST /v1/deny-list/users/remove
GroupApi addUserToGroup POST /v1/groups/{groupName}/users
GroupApi createGroup POST /v1/groups
GroupApi deleteGroup DELETE /v1/groups/{groupName}
GroupApi getGroupById GET /v1/groups/{groupName}
GroupApi listGroupUserMappings GET /v1/groups/{groupName}/users
GroupApi listGroups GET /v1/groups
GroupApi removeUserFromGroup DELETE /v1/groups/{groupName}/users
IdpApi v1LoginProjectProjectIdOauth2AuthGet GET /v1/login/project/{projectId}/oauth2/auth OAuth 2.0 Authorize Endpoint
IdpApi v1LoginProjectProjectIdOauth2RevokePost POST /v1/login/project/{projectId}/oauth2/revoke Revoke OAuth 2.0 Access or Refresh Token
IdpApi v1LoginProjectProjectIdOauth2SessionsLogoutGet GET /v1/login/project/{projectId}/oauth2/sessions/logout OpenID Connect Front- and Back-channel Enabled Logout
IdpApi v1LoginProjectProjectIdOauth2TokenPost POST /v1/login/project/{projectId}/oauth2/token The OAuth 2.0 Token Endpoint
IdpApi v1LoginProjectProjectIdUserinfoGet GET /v1/login/project/{projectId}/userinfo OpenID Connect Userinfo
IdpApi v1LoginProjectProjectIdWellKnownJwksJsonGet GET /v1/login/project/{projectId}/.well-known/jwks.json Discover Well-Known JSON Web Keys
IdpApi v1LoginProjectProjectIdWellKnownOpenidConfigurationGet GET /v1/login/project/{projectId}/.well-known/openid-configuration OpenID Connect Discovery

Models

Authorization

Authentication schemes defined for the API:

AwsSigV4

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

ApiKey

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

bearerAuth

  • Type: Bearer authentication (JWT)

ConsumerTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

UserTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

ProjectTokenAuth

  • Type: API key
  • API key parameter name: authorization
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

[email protected]

About this package

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

  • API version: 1.0.0
    • Generator version: 7.13.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen