OAuth

OAuth

OAuth 1.2.7

Security

This is the OAuth service that can be called to return an OAuth bearer token using the implicit OAuth flow.

expand_moreexpand_lessContact information
rAPIdLink Support Team
expand_moreexpand_lessLicense
Terms and Conditions
production
development
https://api.rapidlink.piraeusbank.gr/piraeusbank/production

Base Gateway API Endpoint

Paths

/oauth2/authorize

get /oauth2/authorize

endpoint for Authorization Code and Implicit grants

description

response_type
Required in query
string

Request an authorization code or access token (implicit)

{
    "enum": [
        "code",
        "token"
    ]
}
client_id
Required in query
string

Application client ID.

scope
Required in query
string

Scope being requested.

redirect_uri
Optional in query
string

URI to where the user is redirected after authorization.

state
Optional in query
string

This string will be echoed back to application when the user is redirected.

Accept
Optional in header
string
application/json
lisa.pavlidi@gr.ey.com
200

An HTML form for authentication or authorization of this request.

302

Redirect to the clients redirect_uri containing one of the following

  • authorization code for Authorization code grant
  • access token for Implicity grant
  • error in case of errors, such as the user has denied the request
Example Request
Example Response
GET https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/authorize
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/authorize
accept
response_type
client_id
scope
redirect_uri
state
post /oauth2/authorize

submit approval to authorization code or access token

Submit resource owners approval (or rejection) for the OAuth2 Server to issue an authorization code or access token to the application.

client_id
Required in formData
string

application requesting the access code or token

scope
Required in formData
string

requested scope of this authorization

resource-owner
Required in formData
string

resource owners user name

redirect_uri
Required in formData
string

URI the application is requesting this code or token to be redirected to

original-url
Required in formData
string

URL of the original authorization request

dp-state
Required in formData
string

state information provided in the authorization form

dp-data
Required in formData
string

state information provided in the authorization form

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
lisa.pavlidi@gr.ey.com
200

Cool

Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/authorize
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/authorize
content-type
accept
client_id
scope
resource-owner
redirect_uri
original-url
dp-state
dp-data

/oauth2/token

post /oauth2/token

Request Access Tokens

This endpoint allows requesting an access token following one of the flows below:- Authorization Code (exchange code for access token)- Client Credentials (2-legged, there is no resource owner information)- Resource Owner Password Credentials (2-legged, client provides resource owner name and password)- Refresh Token (exchange refresh token for a new access code). The table below indicates the required parameters for each specific grant_type options. Empty cells indicate a parameter is ignored for that specific grant type. Client authentication:- Confidential clients should authenticate using HTTP Basic Authentication. Alternatively, they may post their client_id and client_secret information as a formData parameter. - Public clients should send their client_id as formData parameter.| grant_type | code | client_credentials | password | refresh_token ||----------------------|------------|--------------------|-------------|---------------|| client_id | required | required | required | required || client_secret | required | required | required | required || code | required | | | || redirect_uri | required | | | || username | | | required | || password | | | required | || scope | | optional | optional | || refresh_token | | | | required |The implicit grant requests, see /oauth2/authorize.

grant_type
Required in formData
string

Type of grant.

{
    "enum": [
        "authorization_code",
        "password",
        "client_credentials",
        "refresh_token"
    ]
}
client_id
Optional in formData
string

Application client ID, may be provided either within formData or using HTTP Basic Authentication.

client_secret
Optional in formData
string

Application secret, may be provided either within formData or using HTTP Basic Authentication.

code
Optional in formData
string

Authorization code provided by the /oauth2/authorize endpoint.

redirect_uri
Optional in formData
string

Required only if the redirect_uri parameter was included in the authorization request /oauth2/authorize. Their values MUST be identical.

username
Optional in formData
string

Resource owner username.

password
Optional in formData
string

Resource owner password.

scope
Optional in formData
string

Scope being requested.

refresh_token
Optional in formData
string

The refresh token that the client wants to exchange for a new access token (refresh_token grant_type).

Content-Type
Optional in header
string
application/x-www-form-urlencoded
Accept
Optional in header
string
application/json
lisa.pavlidi@gr.ey.com
200

JSON document containing token, etc.

access_token_response
400

JSON document that may contain additional details about the failure.

Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/token
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/token
content-type
accept
grant_type
client_id
client_secret
code
redirect_uri
username
password
scope
refresh_token

/oauth2/introspect

post /oauth2/introspect

Introspect a given access_token supported

This endpoint introspects a given access_token

token
Required in formData
string

String value of the access_token to be introspected

token_type_hint
Required in formData
string

This must contain 'access_token' to indicate the token type

Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
lisa.pavlidi@gr.ey.com
200

json document containing access_token information, etc.

introspect_response
401

failure

Example Request
Example Response
POST https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/introspect
Try this operation
https://api.rapidlink.piraeusbank.gr/piraeusbank/production/v1.2.7/oauth/oauth2/introspect
content-type
accept
token
token_type_hint

Definitions 

{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "token_type",
        "access_token",
        "expires_in"
    ],
    "properties": {
        "token_type": {
            "enum": [
                "bearer"
            ],
            "type": "string"
        },
        "access_token": {
            "type": "string"
        },
        "expires_in": {
            "type": "integer"
        },
        "scope": {
            "type": "string"
        },
        "refresh_token": {
            "type": "string"
        },
        "metadata": {
            "properties": [],
            "type": "string"
        }
    }
}
              
{
    "type": "object",
    "additionalProperties": false,
    "required": [
        "active",
        "client_id",
        "client_name",
        "username",
        "sub",
        "exp",
        "expstr",
        "iat",
        "nbf",
        "nbfstr",
        "scope"
    ],
    "properties": {
        "active": {
            "type": "boolean"
        },
        "client_id": {
            "type": "string"
        },
        "client_name": {
            "type": "string"
        },
        "username": {
            "type": "string"
        },
        "sub": {
            "type": "string"
        },
        "exp": {
            "type": "string"
        },
        "expstr": {
            "type": "string"
        },
        "iat": {
            "type": "string"
        },
        "nbf": {
            "type": "string"
        },
        "nbfstr": {
            "type": "string"
        },
        "scope": {
            "type": "string"
        },
        "miscinfo": {
            "type": "string"
        },
        "consented_on": {
            "type": "string"
        },
        "consented_on_str": {
            "type": "string"
        },
        "grant_type": {
            "type": "string"
        }
    }
}