Skip to content

Latest commit

 

History

History
238 lines (178 loc) · 9.03 KB

UsersCompanyLevelApi.md

File metadata and controls

238 lines (178 loc) · 9.03 KB
Raw

UsersCompanyLevelApi

All URIs are relative to https://management-test.adyen.com/v3

Method HTTP request Description
getCompaniesCompanyIdUsers GET /companies/{companyId}/users Get a list of users
getCompaniesCompanyIdUsersUserId GET /companies/{companyId}/users/{userId} Get user details
patchCompaniesCompanyIdUsersUserId PATCH /companies/{companyId}/users/{userId} Update user details
postCompaniesCompanyIdUsers POST /companies/{companyId}/users Create a new user

getCompaniesCompanyIdUsers

ListCompanyUsersResponse getCompaniesCompanyIdUsers(companyId, pageNumber, pageSize, username)

Get a list of users

Returns the list of users for the `companyId` identified in the path. To make this request, your API credential must have the following role: * Management API—Users read and write

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.management.*

val apiInstance = UsersCompanyLevelApi()
val companyId : kotlin.String = companyId_example // kotlin.String | The unique identifier of the company account.
val pageNumber : kotlin.Int = 56 // kotlin.Int | The number of the page to return.
val pageSize : kotlin.Int = 56 // kotlin.Int | The number of items to have on a page. Maximum value is **100**. The default is **10** items on a page.
val username : kotlin.String = username_example // kotlin.String | The partial or complete username to select all users that match.
try {
    val result : ListCompanyUsersResponse = apiInstance.getCompaniesCompanyIdUsers(companyId, pageNumber, pageSize, username)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersCompanyLevelApi#getCompaniesCompanyIdUsers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersCompanyLevelApi#getCompaniesCompanyIdUsers")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
companyId kotlin.String The unique identifier of the company account.
pageNumber kotlin.Int The number of the page to return. [optional]
pageSize kotlin.Int The number of items to have on a page. Maximum value is 100. The default is 10 items on a page. [optional]
username kotlin.String The partial or complete username to select all users that match. [optional]

Return type

ListCompanyUsersResponse

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getCompaniesCompanyIdUsersUserId

CompanyUser getCompaniesCompanyIdUsersUserId(companyId, userId)

Get user details

Returns user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following role: * Management API—Users read and write

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.management.*

val apiInstance = UsersCompanyLevelApi()
val companyId : kotlin.String = companyId_example // kotlin.String | The unique identifier of the company account.
val userId : kotlin.String = userId_example // kotlin.String | The unique identifier of the user.
try {
    val result : CompanyUser = apiInstance.getCompaniesCompanyIdUsersUserId(companyId, userId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersCompanyLevelApi#getCompaniesCompanyIdUsersUserId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersCompanyLevelApi#getCompaniesCompanyIdUsersUserId")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
companyId kotlin.String The unique identifier of the company account.
userId kotlin.String The unique identifier of the user.

Return type

CompanyUser

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

patchCompaniesCompanyIdUsersUserId

CompanyUser patchCompaniesCompanyIdUsersUserId(companyId, userId, updateCompanyUserRequest)

Update user details

Updates user details for the `userId` and the `companyId` identified in the path. To make this request, your API credential must have the following role: * Management API—Users read and write

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.management.*

val apiInstance = UsersCompanyLevelApi()
val companyId : kotlin.String = companyId_example // kotlin.String | The unique identifier of the company account.
val userId : kotlin.String = userId_example // kotlin.String | The unique identifier of the user.
val updateCompanyUserRequest : UpdateCompanyUserRequest =  // UpdateCompanyUserRequest | 
try {
    val result : CompanyUser = apiInstance.patchCompaniesCompanyIdUsersUserId(companyId, userId, updateCompanyUserRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersCompanyLevelApi#patchCompaniesCompanyIdUsersUserId")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersCompanyLevelApi#patchCompaniesCompanyIdUsersUserId")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
companyId kotlin.String The unique identifier of the company account.
userId kotlin.String The unique identifier of the user.
updateCompanyUserRequest UpdateCompanyUserRequest [optional]

Return type

CompanyUser

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

postCompaniesCompanyIdUsers

CreateCompanyUserResponse postCompaniesCompanyIdUsers(companyId, createCompanyUserRequest)

Create a new user

Creates the user for the `companyId` identified in the path. To make this request, your API credential must have the following role: * Management API—Users read and write

Example

// Import classes:
//import com.adyen.client.infrastructure.*
//import com.adyen.model.management.*

val apiInstance = UsersCompanyLevelApi()
val companyId : kotlin.String = companyId_example // kotlin.String | The unique identifier of the company account.
val createCompanyUserRequest : CreateCompanyUserRequest =  // CreateCompanyUserRequest | 
try {
    val result : CreateCompanyUserResponse = apiInstance.postCompaniesCompanyIdUsers(companyId, createCompanyUserRequest)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersCompanyLevelApi#postCompaniesCompanyIdUsers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersCompanyLevelApi#postCompaniesCompanyIdUsers")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
companyId kotlin.String The unique identifier of the company account.
createCompanyUserRequest CreateCompanyUserRequest [optional]

Return type

CreateCompanyUserResponse

Authorization

Configure ApiKeyAuth: ApiClient.apiKey["X-API-Key"] = "" ApiClient.apiKeyPrefix["X-API-Key"] = "" Configure BasicAuth: ApiClient.username = "" ApiClient.password = ""

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json