Proje içerisinde yer alan Credential'ları kaydetme, silme, güncelleme, listeleme işlemleri için kullanılan servislerdir.

1. Get All Credentials for Specified Project

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yer alan credential'lar listelenir. Eğer proje adı olarak "admin" gönderilirse tüm credential'lar, proje adı gönderilirse sadece projede tanımlı credential'lar listelenir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameSorgulanmak istenen projenin tam adı


Request Body: (none)

Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
    "resultList": [
       {  

          "fullName": "user1",
          "username": "user1",
          "enabled": true,
          "ipList": [
                   "123.123.123",
                   "98.98.15.12"
          ]

        }

    ],
    "resultCount": 1
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


2. Create Credential

Açıklama/Amaç: Parametre olarak ismi gönderilen projede yeni bir credential oluşturulması sağlanır. Eğer proje adı olarak "admin" gönderilirse credential globale tanımlanır. Tanımlanan credential tüm ortamlara deploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/

HTTP Method: POST

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı


Request Body: 

{
  "email": "<STRING>",
  "fullName": "<STRING>",
  "description": "<STRING>",
  "username": "<STRING>",
  "password": "<STRING>",
  "roleNameList": [
    "role1",
    "role2"
  ],
  "enabled": "true",
  "ipList": [
    "90.0.182.75",
    "172.26.100.23"
  ],
  "expireDate":"2023-08-14T00:00:00.000Z"
}

Alan

Açıklama

email

Credential'ın email adresi

fullName

Credential'ın tam adı

description

Credential'a ait açıklama

username

Credential'ın kullanıcı adı

password

Credential'ın parolası

roleNameList

Credential'ın rol listesi

enabled

Credential'ın etkin olma durumu

ipList

Credential'ın IP listesi

expireDate

Credential'ın geçerlilik süresi


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


3. Update Credential

Açıklama/Amaç: Parametre olarak ismi gönderilen projede, istek gövdesinde gönderilen "username" değeri ile bir credential varsa güncellenmesini yoksa oluşturulması sağlanır. Eğer proje adı olarak "admin" gönderilirse credential globale tanımlanır. Tanımlanan/Güncellenen credential tüm ortamlara deploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/

HTTP Method: PUT

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı


Request Body: 

{
  "email": "<STRING>",
  "fullName": "<STRING>",
  "description": "<STRING>",
  "username": "<STRING>",
  "password": "<STRING>",
  "roleNameList": [
    "role1",
    "role2"
  ],
  "enabled": "true",
  "ipList": [
    "90.0.182.75",
    "172.26.100.23"
  ],
  "expireDate":"2023-08-14T00:00:00.000Z"
}

Alan

Açıklama

email

Credential'ın email adresi

fullName

Credential'ın tam adı

description

Credential'a ait açıklama

username

Credential'ın kullanıcı adı

password

Credential'ın parolası

roleNameList

Credential'ın rol listesi

enabled

Credential'ın etkin olma durumu

ipList

Credential'ın IP listesi

expireDate

Credential'ın geçerlilik süresi


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


4. Change Credential Password

Açıklama/Amaç: Parametre olarak "kullanıcı adı" gönderilen credential'ın şifresinin güncellenmesini sağlar. Güncellenen credential tüm ortamlara deploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/{username}/

HTTP Method: PATCH

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı
usernameCredential'ın kullanıcı adı


Request Body: 

{
  "password": "<STRING>"
}

Alan

Açıklama

password

Credential'ın parolası


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


5. Delete Credential

Açıklama/Amaç: Parametre olarak "kullanıcı adı" gönderilen credential'ın silinmesini sağlar. Silinen credential tüm ortamlardan undeploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/{username}/

HTTP Method: DELETE

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı
usernameCredential'ın kullanıcı adı


Request Body:  (none)

Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
    "status": "SUCCESS",
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


6. Get Granted Access List of Credential

Açıklama/Amaç: Parametre olarak "kullanıcı adı" gönderilen credential'ın erişimine izin verilen API Proxy ve API Proxy Gruplarının listelenmesini sağlar.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/{username}/access/

HTTP Method: GET

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı
usernameCredential'ın kullanıcı adı


Request Body:  (none)

Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
"status": "SUCCESS",
"resultList": [
    {
       "name": "Calculator",
       "type": "API_PROXY"
   }
],
"resultCount": 1
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}


7. Grant Access for Credential

Açıklama/Amaç: Parametre olarak "kullanıcı adı" gönderilen credential'a, parametre olarak gönderilen API Proxy veya API Proxy Gruplarına erişim izni verilmesini sağlar. Güncellenen yetkiler tüm ortamlara deploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/{username}/access/

HTTP Method: PUT

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı
usernameCredential'ın kullanıcı adı


Request Body:

[

    {
       "name": "Calculator",
        "type": "API_PROXY"
    },

   {
       "name": "Account Proxy Group",
        "type": "API_PROXY_GROUP"
    }

]

Alan

Açıklama

name

API Proxy/API Proxy Grup adı

type

API Proxy/API Proxy Grup bilgisi


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
   "status": "SUCCESS"
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}



8. Revoke Access from Credential

Açıklama/Amaç: Parametre olarak "kullanıcı adı" gönderilen credential'dan, parametre olarak gönderilen API Proxy veya API Proxy Gruplarındaki erişim izninin kaldırılmasını sağlar. Silinen yetkiler tüm ortamlardan undeploy edilir.

Yetkilendirme: Servislere erişim için erişmek isteyen kullanıcının proje içerisinde "Manage API Security

Endpoint: https://<APINIZER_MANAGER_ADDRESS>/apiops/projects/{projectName}/credentials/{username}/access/

HTTP Method: DELETE

Request Headers: 

Header

Value

Authorization

<ACCESS_TOKEN>

Bu uç noktaya erişim için Token alınması gereklidir.

Nasıl token alınacağı ile ilgili detaylı bilgi için Yetkilendirme API'si sayfasını ziyaret edebilirsiniz.

Acceptapplication/json


Request Path Parameters:

Parameter

Value

projectNameCredential'ın bulunduğu projenin tam adı
usernameCredential'ın kullanıcı adı


Request Body:

[

    {
       "name": "Calculator",
        "type": "API_PROXY"
    },

   {
       "name": "Account Proxy Group",
        "type": "API_PROXY_GROUP"
    }

]

Alan

Açıklama

name

API Proxy/API Proxy Grup adı

type

API Proxy/API Proxy Grup bilgisi


Response:

Status

Status Code

Description

Body

Başarılı200

successful operation

{
   "status": "SUCCESS"
}

Hatalı400bad request{
    "error": "...",
    "error_description": "..."
}
Hatalı401not authorized for this operation

{
    "error": "unauthorized_client",
    "error_description": "..."
}

Hatalı500internal error{
    "error": "...",
    "error_description": "..."
}