UsersApi

All URIs are relative to http://localhost

Method	HTTP request	Description
assignRoleToUser	POST /v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Assign Role To User
createUser	POST /v2/facts/{proj_id}/{env_id}/users	Create User
deleteUser	DELETE /v2/facts/{proj_id}/{env_id}/users/{user_id}	Delete User
getUser	GET /v2/facts/{proj_id}/{env_id}/users/{user_id}	Get User
listUsers	GET /v2/facts/{proj_id}/{env_id}/users	List Users
replaceUser	PUT /v2/facts/{proj_id}/{env_id}/users/{user_id}	Replace User
unassignRoleFromUser	DELETE /v2/facts/{proj_id}/{env_id}/users/{user_id}/roles	Unassign Role From User
updateUser	PATCH /v2/facts/{proj_id}/{env_id}/users/{user_id}	Update User

assignRoleToUser

RoleAssignmentRead assignRoleToUser(projId, envId, userId, userRoleCreate)

Assign Role To User

Assigns a role to the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
val userRoleCreate : UserRoleCreate =  // UserRoleCreate | 
try {
    val result : RoleAssignmentRead = apiInstance.assignRoleToUser(projId, envId, userId, userRoleCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#assignRoleToUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#assignRoleToUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
userRoleCreate	UserRoleCreate

Return type

RoleAssignmentRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

createUser

UserRead createUser(projId, envId, userCreate)

Create User

Creates a new user inside the Permit.io system, from that point forward you may run permission checks on that user. If the user is already created: will return 200 instead of 201, and will return the existing user object in the response body.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userCreate : UserCreate =  // UserCreate | 
try {
    val result : UserRead = apiInstance.createUser(projId, envId, userCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#createUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#createUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userCreate	UserCreate

Return type

UserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

deleteUser

deleteUser(projId, envId, userId)

Delete User

Deletes the user and all its related data.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
try {
    apiInstance.deleteUser(projId, envId, userId)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#deleteUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#deleteUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Return type

null (empty response body)

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

getUser

UserRead getUser(projId, envId, userId)

Get User

Gets a user, if such user exists. Otherwise returns 404.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
try {
    val result : UserRead = apiInstance.getUser(projId, envId, userId)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#getUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#getUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Return type

UserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

listUsers

PaginatedResultUserRead listUsers(projId, envId, search, page, perPage)

List Users

Lists all the users defined within an environment.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val search : kotlin.String = search_example // kotlin.String | Text search for the email field
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 : PaginatedResultUserRead = apiInstance.listUsers(projId, envId, search, page, perPage)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#listUsers")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#listUsers")
    e.printStackTrace()
}

Parameters

Name	Type	Description	Notes
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
search	kotlin.String	Text search for the email field	[optional]
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

PaginatedResultUserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

Content-Type: Not defined
Accept: application/json

replaceUser

UserRead replaceUser(projId, envId, userId, userCreate)

Replace User

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
val userCreate : UserCreate =  // UserCreate | 
try {
    val result : UserRead = apiInstance.replaceUser(projId, envId, userId, userCreate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#replaceUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#replaceUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
userCreate	UserCreate

Return type

UserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

unassignRoleFromUser

UserRead unassignRoleFromUser(projId, envId, userId, userRoleRemove)

Unassign Role From User

Unassigns the role from the user within the tenant. The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant. If the role is not actually assigned, will return 404.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
val userRoleRemove : UserRoleRemove =  // UserRoleRemove | 
try {
    val result : UserRead = apiInstance.unassignRoleFromUser(projId, envId, userId, userRoleRemove)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#unassignRoleFromUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#unassignRoleFromUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
userRoleRemove	UserRoleRemove

Return type

UserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

updateUser

UserRead updateUser(projId, envId, userId, userUpdate)

Update User

Partially updates the user definition. Fields that will be provided will be completely overwritten.

Example

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

val apiInstance = UsersApi()
val projId : kotlin.String = projId_example // kotlin.String | Either the unique id of the project, or the URL-friendly key of the project (i.e: the \"slug\").
val envId : kotlin.String = envId_example // kotlin.String | Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the \"slug\").
val userId : kotlin.String = userId_example // kotlin.String | Either the unique id of the user, or the URL-friendly key of the user (i.e: the \"slug\").
val userUpdate : UserUpdate =  // UserUpdate | 
try {
    val result : UserRead = apiInstance.updateUser(projId, envId, userId, userUpdate)
    println(result)
} catch (e: ClientException) {
    println("4xx response calling UsersApi#updateUser")
    e.printStackTrace()
} catch (e: ServerException) {
    println("5xx response calling UsersApi#updateUser")
    e.printStackTrace()
}

Parameters

Name	Type	Description
projId	kotlin.String	Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").
envId	kotlin.String	Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").
userId	kotlin.String	Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").
userUpdate	UserUpdate

Return type

UserRead

Authorization

Configure HTTPBearer: ApiClient.accessToken = ""

HTTP request headers

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

Files

UsersApi.md

Latest commit

History

UsersApi.md

File metadata and controls

UsersApi

assignRoleToUser

Example

Parameters

Return type

Authorization

HTTP request headers

createUser

Example

Parameters

Return type

Authorization

HTTP request headers

deleteUser

Example

Parameters

Return type

Authorization

HTTP request headers

getUser

Example

Parameters

Return type

Authorization

HTTP request headers

listUsers

Example

Parameters

Return type

Authorization

HTTP request headers

replaceUser

Example

Parameters

Return type

Authorization

HTTP request headers

unassignRoleFromUser

Example

Parameters

Return type

Authorization

HTTP request headers

updateUser

Example

Parameters

Return type

Authorization

HTTP request headers