{
"opencollection": "1.0.0",
"info": {
"name": "Port Action Runs Users API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "Users",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get all users in your organization",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/users",
"params": [
{
"name": "fields",
"value": "",
"type": "query",
"description": "The fields you want to fetch for each user. If used, only the specified fields will be included in the response."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to fetch all of the users in your Port organization.
To learn more about users, check out the [documentation](https://docs.port.io/sso-rbac/rbac-overview/)."
},
{
"info": {
"name": "Invite a user to your organization",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/v1/users/invite",
"params": [
{
"name": "notify",
"value": "",
"type": "query",
"description": "If `true`, the invitee will receive an email notification."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to invite a user to your Port organization.
To learn more about users, roles, and teams, check out the [documentation](https://docs.port.io/sso-rbac/rbac-overview/)."
},
{
"info": {
"name": "Get a user",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/v1/users/:user_email",
"params": [
{
"name": "user_email",
"value": "",
"type": "path",
"description": "The email address of the user you want to operate on."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to fetch a specific user in your Port organization.
To learn more about users, check out the [documentation](https://docs.port.io/sso-rbac/rbac-overview/)."
},
{
"info": {
"name": "Update a user",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/v1/users/:user_email",
"params": [
{
"name": "user_email",
"value": "",
"type": "path",
"description": "The email address of the user you want to operate on."
}
],
"body": {
"type": "json",
"data": "{}"
},
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to update a user's details. This can be used to update the user's role/s and team/s.
To learn more about users, roles, and teams, check out the [documentation](https://docs.port.io/sso-rbac/rbac-overview/)."
},
{
"info": {
"name": "Delete a user",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/v1/users/:user_email",
"params": [
{
"name": "user_email",
"value": "",
"type": "path",
"description": "The email address of the user you want to operate on."
}
],
"auth": {
"type": "apikey",
"key": "Authorization",
"value": "{{Authorization}}",
"placement": "header"
}
},
"docs": "This route allows you to delete a user in your Port organization.
To learn more about users, check out the [documentation](https://docs.port.io/sso-rbac/rbac-overview/)."
}
]
}
],
"bundled": true
}