The passly Developer Hub

Welcome to the passly developer hub. You'll find comprehensive guides and documentation to help you start working with passly as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started
Suggest Edits

Add User

Adds a User to your passly domain

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/users
curl "https://api.passly.io/$PASSLY_DOMAIN/users" \
  	 -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-type: application/json' \
     -d '{
       "name":"Bob Smith",
       "email":"bob@example.com",
       "username":"bob", "user_id":"a123"
     }'
A binary file was returned

You couldn't be authenticated

{
	"passly_id":"19282"
}
{
  "error": {
  	"message":"Missing Parameter in request", 
  	"code":"MissingParam"
  }
} 
{
  "error": {
    "message": "The user with that email already exists",
    "code": "UserEmailExists"
  }
}
{
  "error": {
    "message": "The user with that userId already exists",
    "code": "UserIdExists"
  }
}
{
  "error": {
    "message": "The user with that username already exists",
    "code": "UsernameExists"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

Body Params

name
string

The customer supplied full name of the user.

email
string
required

The email address for the user.

username
string

The customer supplied username for this user.

user_id
string

The customer supplied userId for this user.

 

The Add User API call adds a user to Passly. The email address for the user is required and must be unique within your Passly domain. The user_id and username are optional but if they are specified they must both be unique within your Passly domain.

If the user was successfully added this API call returns the unique Passly generated Passly_id for that user.

Suggest Edits

List Users

Lists the users within your passly domain

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users
curl "https://api.passly.io/$PASSLY_DOMAIN/users?page_size=2" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
   "marker":"kctAc8AAAAAAAA",
   "users":[
      {
         "passly_id":317,
         "name":"3USER100",
         "email":"3user100@example.com",
         "username":"3user 100 name",
         "user_id":"3100",
         "created":"2017-04-10T18:54:23.843Z"
      },
      {
         "passly_id":316,
         "name":"3USER99",
         "email":"3user99@example.com",
         "username":"3user 99 name",
         "user_id":"399",
         "created":"2017-04-10T18:54:23.233Z"
      }
   ]
}
{
  "error": {
  	"message":"Missing Parameter in request", 
  	"code":"MissingParam"
  }
} 

Path Params

passly_domain
string
required

The passly domain for your account.

Query Params

page_size
int32

The number of users to return in a single page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for pagination.

 

The List Users API call returns a list of users in a Passly domain.

This API is paginated and by default returns 100 users in descending order by their passly_id. If there are additional users available then a marker is returned that can be used in a subsequent call to request the next page of users. For more information on pagination see the pagination docs.

Suggest Edits

Get User by Email

Returns the details of one user by the customer supplied email address

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/email/email_address
curl "https://api.passly.io/$PASSLY_DOMAIN/users/email/bob@example.com" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "passly_id":310,
  "name":"Bob Smith",
  "email":"bob@example.com",
  "user_id":"a123",
  "username":"bob",
  "created":"2017-04-01T19:36:23.153Z"
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

email_address
string
required

The customer supplied email address that you want to query for.

 

Returns the details of the user with that specified email address. If the user is not found this API call returns a 404 Not Found

Suggest Edits

Get User by Username

Returns the details of one user by the customer supplied username

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/email/username
curl "https://api.passly.io/$PASSLY_DOMAIN/users/username/bob" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "passly_id":310,
  "name":"Bob Smith",
  "email":"bob@example.com",
  "user_id":"a123",
  "username":"bob",
  "created":"2017-04-01T19:36:23.153Z"
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

username
string
required

The customer supplied username to query for.

 

Returns the details of the user with that specified username. If the user is not found this API call returns a 404 Not Found

Suggest Edits

Get User by UserId

Returns the details of one user by the customer supplied user_id

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/userid/user_id
curl "https://api.passly.io/$PASSLY_DOMAIN/users/userid/bob" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "passly_id":310,
  "name":"Bob Smith",
  "email":"bob@example.com",
  "user_id":"a123",
  "username":"bob",
  "created":"2017-04-01T19:36:23.153Z"
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

user_id
string
required

The customer supplied user_id to query for.

 

Returns the details of the user with that specified user_id. If the user is not found this API call returns a 404 Not Found

Suggest Edits

Get User by PasslyId

Returns the details of one user by the unique passly_id

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/passly_id
curl "https://api.passly.io/$PASSLY_DOMAIN/users/310" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "passly_id":310,
  "name":"Bob Smith",
  "email":"bob@example.com",
  "user_id":"a123",
  "username":"bob",
  "created":"2017-04-01T19:36:23.153Z"
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

passly_id
int64
required

The unique passly_id to query for.

 

Returns the details of the user with that specified passly_id. If the user is not found this API call returns a 404 Not Found

Suggest Edits

Delete User by PasslyId

Deletes the user with the specified passly_id

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/users/passly_id
curl "https://api.passly.io/$PASSLY_DOMAIN/users/315" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE5
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested user is a member of groups"
    ,"code":"UserInGroups"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

passly_id
int64
required

The unique passly_id to delete.

 

The Delete User by PasslyId deletes the user with the specified passly_id. If the user is not found then this API returns a 404 Not Found.

If the user is a member of any groups or if this user is bound to any policies then this API returns an error.

Suggest Edits

Delete User by Email

Deletes the user with the specified customer supplied email address

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/users/email/email
curl "https://api.passly.io/$PASSLY_DOMAIN/users/email/bob@example.com" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested user is a member of groups"
    ,"code":"UserInGroups"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

email
string
required

The customer supplied email address for the user you want to delete.

 

Deletes the user with the specified customer supplied email address. If the user is not found then this API returns a 404 Not Found.

If the user is a member of any groups or if this user is bound to any policies then this API returns an error.

Suggest Edits

Delete User by Username

Deletes the user with the specified customer supplied username

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/users/username/username
curl "https://api.passly.io/$PASSLY_DOMAIN/users/username/bob" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested user is a member of groups"
    ,"code":"UserInGroups"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

username
string
required

The customer supplied username for the user you want to delete.

 

Deletes the user with the specified customer supplied username. If the user is not found then this API returns a 404 Not Found.

If the user is a member of any groups or if this user is bound to any policies then this API returns an error.

Suggest Edits

Delete User by UserId

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/users/userid/user_id
curl "https://api.passly.io/$PASSLY_DOMAIN/users/userid/a123" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error": {
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested user is a member of groups"
    ,"code":"UserInGroups"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

user_id
string
required

The customer supplied user_id for the user that you want to delete.

 

Deletes the user with the specified customer supplied user_id. If the user is not found then this API returns a 404 Not Found.

If the user is a member of any groups or if this user is bound to any policies then this API returns an error.

Suggest Edits

Add Group

Adds a group to your passly domain

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/groups
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "namespace": "software",
       "group_name": "Software Group"
     }'
A binary file was returned

You couldn't be authenticated

{
  "namespace":"software",
  "group_id":10,
  "group_name":"Software Group"
}
{
  "error":{
    "message":"The group with that name already exists",
    "code":"GroupExists"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

Body Params

group_name
string
required

The name of the group to add.

namespace
string

The namespace for this group.

 

The Add Group API call creates a group, in a namespace, in passly. The group name is required and must be unique within a namespace in your passly domain. The namespace is optional and defaults to default.

If the group was successfully added this API call returns the unique passly generated group_id for that group.

Suggest Edits

List Group Members by Group Id

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/groups/group_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/10" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "namespace":"software",
  "group_id":13,
  "group_name":"Software Group",
  "members":[
    "316",
    "315",
    "314",
    "211",
    "199"
  ],
  "created":"2017-04-10T20:19:27.712Z"
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

group_id
int64
required

The Passly group id identifying the group to list members.

Query Params

page_size
int32

The number of mbmbers to return in a single page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for pagination.

 

The List Group Members by Group ID API call returns a list of users, in a group, in your Passly domain. If the group is not found this API call returns a 404 Not Found

This API is paginated and by default returns 100 members in descending order by their passly_id. If there are additional members available then a marker is returned that can be used in a subsequent call to request the next page of members. For more information on pagination see the pagination docs.

Suggest Edits

List Group Members by Group Name

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/groups/namespace/group_name
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/software/Software%20Group" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "namespace":"software",
  "group_id":13,
  "group_name":"Software Group",
  "members":[
    "316",
    "315",
    "314",
    "211",
    "199"
  ],
  "created":"2017-04-10T20:19:27.712Z"
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

namespace
string
required

The namespace that containes the group to be listed.

group_name
string
required

The name of the group to list members.

Query Params

page_size
int32

The maximum number of members to return in one page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for the next page of results.

 

The List Group Members by Group Name API call returns a list of users, in a group, in your passly domain. If the group is not found this API call returns a 404 Not Found

This API is paginated and by default returns 100 members in descending order by their passly_id. If there are additional members available then a marker is returned that can be used in a subsequent call to request the next page of members. For more information on pagination see the pagination docs.

Suggest Edits

Delete Group

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/groups/group_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/2" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested group has members",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

group_id
int64
required

The Passly id of the group to be deleted.

 

The Delete Group API deletes the group with the specified Passly group id. If the group is not found then this API returns a 404 Not Found.

If the group has any members then this API returns a 404 Not Found.

Suggest Edits

List Groups

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/groups
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/?namespace=software" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "groups":[
    {
      "namespace":"software",
      "group_id":14,
      "group_name":"Software Group",
      "created":"2017-04-10T20:39:11.493Z"
    }
  ]
}

Path Params

passly_domain
string
required

The passly domain for your account.

Query Params

namespace
string

The namespace to filter by.

page_size
int32

The maximum number of groups to return in one page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for the next page of results.

 

The List Groups API call will list the groups in a Passly domain.

This API is paginated and by default returns 100 groups in descending order by their Passly id. If there are additional groups available then a marker is returned that can be used in a subsequent call to request the next page of groups. For more information on pagination see the pagination docs.

Suggest Edits

Add User to Group

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/groups/group_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/13" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "user_passly_id": "316"
     }'
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The user already exists in the group",
    "code":"UserAlreadyExists"
  }
}
{
	"error":{
		"message":"The requested user was not found",
		"code":"UserNotFound"
	}
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

group_id
int64
required

The Passly group id the user is being added to.

Body Params

user_passly_id
int64
required

The users Passly id to add to the group.

 

The Add User to Group API call will add an existing Passly user to an exisitng Passly group in a Passly domain.

Suggest Edits

Add User to Group by Group Name

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/groups/namespace/group_name
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/software/Software%20Group" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "user_passly_id": "317"
     }'
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The user already exists in the group",
    "code":"UserAlreadyExists"
  }
}
{
	"error":{
		"message":"The requested user was not found",
		"code":"UserNotFound"
	}
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

namespace
string
required

The namespace the group exists in.

group_name
string
required

The group name. Must be html encoded.

Body Params

user_passly_id
int64
required

The users Passly id to add to the group.

 

The Add User to Group by Group Name API call will add an existing Passly user to an exisitng Passly group in a Passly domain.

Suggest Edits

Remove User from Group

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/groups/group_id/user_passly_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/13/314" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

group_id
int64
required

The Passly group id of the group to have a user removed.

user_passly_id
int64
required

The user Passly id for the user to remove from the group.

 

The Remove User from Group API call will remove a user from a specific group in a Passly domain.

Suggest Edits

Remove User from Group by Group Name

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/groups/namespace/group_name/user_passly_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/software/Software%20Group/316" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

namespace
string
required

The namespace of the group to remove users from.

group_name
string
required

The group name of the group to remove users from.

user_passly_id
int64
required

The user Passly id to remove from the group.

 

The Remove User from Group by Group Name API call will remove a user from a group, in a specific namespace, in a Passly domain.

Suggest Edits

List Groups for User

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/user_passly_id/groups
curl "https://api.passly.io/$PASSLY_DOMAIN/users/317/groups" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET 
A binary file was returned

You couldn't be authenticated

{
  "groups":[
    {
      "namespace":"software",
      "group_id":14,
      "group_name":"Software Group"
    },
    {
      "namespace":"default",
      "group_id":13,
      "group_name":"TestGroup"
    }
  ]
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

user_passly_id
int64
required

The user Passly id for the user whose groups wish to be listed.

Query Params

page_size
int32

The number of groups to return in a single page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for pagination.

 

The List Groups for User API call will list the Passy groups a user belongs to.

Suggest Edits

Create Policy

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "name": "example",
       "resources":[
          "http://www.example.com/*"
       ],
       "permissions":[
          "READ",
          "WRITE"
       ]
     }'
A binary file was returned

You couldn't be authenticated

{
  "version":"1.0",
  "name":"example",
  "policy_id":6
}
{
  "error":{
    "message":"Missing Field 'resources' in content",
    "code":"BadContent"
  }
}
{
  "error":{
    "message":"Missing Field 'permissions' in content",
    "code":"BadContent"
  }
}
{
  "error":{
    "message":"Missing Field 'name' in content",
    "code":"BadContent"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

Body Params

name
string
required

The name of the policy.

resources
array of strings
required

A list of URI resources for which this policy applies to.

permissions
array of strings
required

A list of permissions which applies to each URI resource.

version
string

The version of the policy. This is not configurable currently.

 

The Create Policy API call will create a new policy with one or more URI resources associated with one or more permissions.

Suggest Edits

List Policies

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET  
A binary file was returned

You couldn't be authenticated

{
  "policies":[
    {
      "name":"test",
      "policy_id":7
    },{
      "name":"example",
      "policy_id":6
    }
  ]
}

Path Params

passly_domain
string
required

The passly domain for your account.

Query Params

page_size
int32

The maximum number of policies to return in one page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for the next page of results.

 

The List Policies API call will list the policies in a Passly domain.

This API is paginated and by default returns 100 policies in descending order by their passly_id. If there are additional policies available then a marker is returned that can be used in a subsequent call to request the next page of policies. For more information on pagination see the pagination docs.

Suggest Edits

Delete Policy

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/policies/policy_id
curl "https://api.passly.io/$PASSLY_DOMAIN/policies/3" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The requested policy was not found",
    "code":"PolicyNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account.

policy_id
int64
required

The Passly policy id that is to be deleted.

 

The Delete Policy API call will delete an existing policy by the Passly policy id.

Suggest Edits

Get Policy

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/policies/policy_id
curl "https://api.passly.io/$PASSLY_DOMAIN/policies/4" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET  
A binary file was returned

You couldn't be authenticated

{
  "version":"1.0",
  "name":"example",
  "policy_id":4,
  "resources":[
    "http://www.example.com/*"
  ],
  "permissions":[
    "read",
    "write"
  ],
  "bindings":[
    
  ],
  "created":"2017-04-10T23:16:49.538Z"
}
{
  "error":{
    "message":"The requested policy was not found",
    "code":"PolicyNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

policy_id
int64
required

The Passly policy id for the policy to be queried.

 

The Get Policy API call will return information on a specific policy by the Passly policy id. Information returned includes:

  • Name
  • Version
  • Policy ID
  • Resources
  • Permissions
  • Policy Bindings
  • Created time
Suggest Edits

Bind Policy to User

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/users/user_passly_id/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/users/316/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "policy_id": "4"
     }'
A binary file was returned

You couldn't be authenticated

{
	"success": true
}
{
  "error":{
    "message":"The requested policy was not found",
    "code":"PolicyNotFound"
  }
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

user_passly_id
int64
required

The Passly user id for the user to be bound to the policy.

Body Params

policy_id
int64
required

The Passly policy id that will be bound to the user.

 

The Bind Policy to User API call will bind a specific policy, by Passly policy id, to a specific user, identified by their Passly user id.

Suggest Edits

List Policies for User

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/users/user_passly_id/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/users/316/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "policies":[
    "4",
    "7"
  ]
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

user_passly_id
int64
required

The Passly user id for the user to list their policies.

Query Params

page_size
int32

The number of policies to return in a single page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for pagination.

 

The List Policies for User API call will list the policies, by Passly policy id, for a specific user identified by Passly user id.

This API is paginated and by default returns 100 policies in descending order by their passly_id. If there are additional policies available then a marker is returned that can be used in a subsequent call to request the next page of policies. For more information on pagination see the pagination docs.

Suggest Edits

Bind Policy to Group

 

Basic Auth

 Authentication is required for this endpoint.
puthttps://api.passly.io/passly_domain/groups/group_id/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/13/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X PUT \
     -H 'Content-Type: application/json' \
     -d '{
       "policy_id": "4"
     }'
A binary file was returned

You couldn't be authenticated

{
	"success": true
}
{
  "error":{
    "message":"The requested policy was not found",
    "code":"PolicyNotFound"
  }
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

group_id
string
required

The Passly group id for the group to be bound to the policy.

Body Params

policy_id
int64
required

The Passly policy id that will be bound to the group.

 

The Bind Policy to Group API call will bind a specific policy, by Passly policy id, to a specific group, identified by their Passly group id.

Suggest Edits

List Policies for Group

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/groups/group_id/policies
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/13/policies" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET
A binary file was returned

You couldn't be authenticated

{
  "policies":[
    "4",
    "9",
    "13"
  ]
}
{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

group_id
int64
required

The Passly group id whose policies will be listed.

Query Params

page_size
int32

The number of policies to return in a single page.

order
string

The sort order: Ascending (asc) or Descending (desc).

marker
string

The marker for pagination.

 

The List Policies for Group API call will list the policies, by Passly policy id, for a specific group identified by Passly group id.

This API is paginated and by default returns 100 policies in descending order by their Passly policy id. If there are additional policies available then a marker is returned that can be used in a subsequent call to request the next page of policies. For more information on pagination see the pagination docs.

Suggest Edits

Unbind Policy from User

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/users/user_passly_id/policies/policy_id
curl "https://api.passly.io/$PASSLY_DOMAIN/users/316/policies/4" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE 
A binary file was returned

You couldn't be authenticated

{
  "success":true
}
{
  "error":{
    "message":"The requested user was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

user_passly_id
int64
required
policy_id
int64
required
 

The Unbind Policy from User API call will unbind (disassociate) a policy, by Passly policy id, from a user identified by their Passly user id.

Suggest Edits

Unbind Policy from Group

 

Basic Auth

 Authentication is required for this endpoint.
deletehttps://api.passly.io/passly_domain/groups/group_id/policies/policy_id
curl "https://api.passly.io/$PASSLY_DOMAIN/groups/13/policies/3" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X DELETE
A binary file was returned

You couldn't be authenticated

{
  "error":{
    "message":"The requested group was not found",
    "code":"UserNotFound"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

group_id
int64
required
policy_id
int64
required
 

The Unbind Policy from Group API call will unbind (disassociate) a policy, by Passly policy id, from a group identified by the Passly group id.

Suggest Edits

Check Permission (GET)

 

Basic Auth

 Authentication is required for this endpoint.
gethttps://api.passly.io/passly_domain/allow
curl "https://api.passly.io/$PASSLY_DOMAIN/allow/?user=317&resource=mailto:support@example.com&permission=read" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X GET 
A binary file was returned

You couldn't be authenticated

{
  "allow":true
}
{
  "allow":false
}
{
  "error":{
    "message":"The specified userId is invalid",
    "code":"InvalidUserId"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

Query Params

user
int64
required

The passly_id for the user

resource
string
required

The resource that you want to check access to

permission
string
required

The permissions that you want to check for

 

The Check Permission API call will validate whether user, identified by their Passly user id, has "permission" to "resource".

Suggest Edits

Check Permission (POST)

 

Basic Auth

 Authentication is required for this endpoint.
posthttps://api.passly.io/passly_domain/allow
curl "https://api.passly.io/$PASSLY_DOMAIN/allow" \
     -i -u _token:$PASSLY_API_TOKEN \
     -X POST \
     -H 'Content-Type: application/json' \
     -d '{
       "user": "317",
       "resource": "mailto:support@example.com",
       "permission": "read"
     }'
A binary file was returned

You couldn't be authenticated

{
  "allow":true
}
{
  "allow":false
}
{
  "error":{
    "message":"The specified userId is invalid",
    "code":"InvalidUserId"
  }
}

Path Params

passly_domain
string
required

The passly domain for your account

Body Params

user
int32
required

The passly_id for the user that you want to check access for

resource
string
required

The resource that you want to check access to

permission
string
required

The permissions that you want to check for

 

The Check Permission API call will validate whether user, identified by their Passly user id, has "permission" to "resource".