Skip to content

Latest commit

 

History

History
257 lines (184 loc) · 7.9 KB

MembersApi.md

File metadata and controls

257 lines (184 loc) · 7.9 KB

MembersApi

All URIs are relative to http://localhost

Method HTTP request Description
deleteOrganizationMember DELETE /v2/members/{member_id} Delete Organization Member
getAuthenticatedMember GET /v2/members/me Get the authenticated account member
getOrganizationMember GET /v2/members/{member_id} Get Organization Member
listOrganizationMembers GET /v2/members List Organization Members
updateOrganizationMember PATCH /v2/members/{member_id} Update Organization Member

deleteOrganizationMember

deleteOrganizationMember(memberId)

Delete Organization Member

Deletes an account member matching the given id or email address. The member will be removed from the active account in permit.io. If the member is the only member in its account (organization), returns 400 (bad request), due to nobody remains with access to the account, meaning deletion of the entire account (org). To completely remove an account, call DELETE `/orgs/{org}`.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = MembersApi()
val memberId : kotlin.String = memberId_example // kotlin.String | Either the unique id (UUID) of the account member, or the email address of the account member.
try {
    apiInstance.deleteOrganizationMember(memberId)
} catch (e: ClientException) {
    println("4xx response calling MembersApi#deleteOrganizationMember")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MembersApi#deleteOrganizationMember")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
memberId kotlin.String Either the unique id (UUID) of the account member, or the email address of the account member.

Return type

null (empty response body)

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

getAuthenticatedMember

OrgMemberRead getAuthenticatedMember()

Get the authenticated account member

Gets the authenticated account member's details.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = MembersApi()
try {
    val result : OrgMemberRead = apiInstance.getAuthenticatedMember()
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MembersApi#getAuthenticatedMember")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MembersApi#getAuthenticatedMember")
    e.printStackTrace()
}

Parameters

This endpoint does not need any parameter.

Return type

OrgMemberRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

getOrganizationMember

OrgMemberRead getOrganizationMember(memberId)

Get Organization Member

Gets a single account member by its id or email address. matching the given member, if no such member exists under the current active account (organization), returns 404.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = MembersApi()
val memberId : kotlin.String = memberId_example // kotlin.String | Either the unique id (UUID) of the account member, or the email address of the account member.
try {
    val result : OrgMemberRead = apiInstance.getOrganizationMember(memberId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MembersApi#getOrganizationMember")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MembersApi#getOrganizationMember")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
memberId kotlin.String Either the unique id (UUID) of the account member, or the email address of the account member.

Return type

OrgMemberRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

listOrganizationMembers

kotlin.collections.List<OrgMemberRead> listOrganizationMembers(page, perPage)

List Organization Members

Lists all the account members that have access to the current active account. The active account/organization is determined by the API Key used or by the authenticated session id.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = MembersApi()
val page : kotlin.Int = 56 // kotlin.Int | Page number of the results to fetch, starting at 1.
val perPage : kotlin.Int = 56 // kotlin.Int | The number of results per page (max 100).
try {
    val result : kotlin.collections.List<OrgMemberRead> = apiInstance.listOrganizationMembers(page, perPage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MembersApi#listOrganizationMembers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MembersApi#listOrganizationMembers")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
page kotlin.Int Page number of the results to fetch, starting at 1. [optional] [default to 1]
perPage kotlin.Int The number of results per page (max 100). [optional] [default to 30]

Return type

kotlin.collections.List<OrgMemberRead>

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

updateOrganizationMember

OrgMemberRead updateOrganizationMember(memberId, orgMemberUpdate)

Update Organization Member

Updates an account member's settings.

Example

// Import classes:
//import org.openapitools.client.infrastructure.*
//import org.openapitools.client.models.*

val apiInstance = MembersApi()
val memberId : kotlin.String = memberId_example // kotlin.String | Either the unique id (UUID) of the account member, or the email address of the account member.
val orgMemberUpdate : OrgMemberUpdate =  // OrgMemberUpdate | 
try {
    val result : OrgMemberRead = apiInstance.updateOrganizationMember(memberId, orgMemberUpdate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling MembersApi#updateOrganizationMember")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling MembersApi#updateOrganizationMember")
    e.printStackTrace()
}

Parameters

Name Type Description Notes
memberId kotlin.String Either the unique id (UUID) of the account member, or the email address of the account member.
orgMemberUpdate OrgMemberUpdate

Return type

OrgMemberRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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