logo
API docs by Redocly

Finmars API (v1)

Download OpenAPI specification:

E-mail: admin@finmars.com License: BSD License Terms of Service

Finmars Documentation

Api

Api V1 Iam Access Policy List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Api V1 Iam Access Policy Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
string or null (Name) <= 255 characters
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
policy
object or null (Policy)

Access Policy JSON

description
string (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Access Policy Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this Access Policy Template.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Access Policy Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this Access Policy Template.

Request Body schema: application/json
required
name
string or null (Name) <= 255 characters
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
policy
object or null (Policy)

Access Policy JSON

description
string (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Access Policy Partial Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this Access Policy Template.

Request Body schema: application/json
required
name
string or null (Name) <= 255 characters
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
policy
object or null (Policy)

Access Policy JSON

description
string (Description)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "policy": { },
  • "description": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Access Policy Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this Access Policy Template.

Responses

Api V1 Iam Group List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Api V1 Iam Group Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
access_policies
Array of strings unique
members
Array of integers unique
roles
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "members_object": [
    ],
  • "roles": [
    ],
  • "roles_object": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Group Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "members_object": [
    ],
  • "roles": [
    ],
  • "roles_object": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Group Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this group.

Request Body schema: application/json
required
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
access_policies
Array of strings unique
members
Array of integers unique
roles
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "members_object": [
    ],
  • "roles": [
    ],
  • "roles_object": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Group Partial Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this group.

Request Body schema: application/json
required
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
access_policies
Array of strings unique
members
Array of integers unique
roles
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "roles": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "access_policies": [
    ],
  • "members": [
    ],
  • "members_object": [
    ],
  • "roles": [
    ],
  • "roles_object": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Group Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this group.

Responses

Api V1 Iam Role List

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
ordering
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

Api V1 Iam Role Create

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
members
Array of integers unique
groups
Array of strings unique
access_policies
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "groups": [
    ],
  • "access_policies": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "members_object": [
    ],
  • "groups": [
    ],
  • "groups_object": [
    ],
  • "access_policies": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Role Read

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this role.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "members_object": [
    ],
  • "groups": [
    ],
  • "groups_object": [
    ],
  • "access_policies": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Role Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this role.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
members
Array of integers unique
groups
Array of strings unique
access_policies
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "groups": [
    ],
  • "access_policies": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "members_object": [
    ],
  • "groups": [
    ],
  • "groups_object": [
    ],
  • "access_policies": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Role Partial Update

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this role.

Request Body schema: application/json
required
name
required
string (Name) [ 1 .. 255 ] characters
description
string (Description)
user_code
required
string (User Code) [ 1 .. 1024 ] characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
members
Array of integers unique
groups
Array of strings unique
access_policies
Array of strings unique

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "groups": [
    ],
  • "access_policies": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "description": "string",
  • "user_code": "string",
  • "configuration_code": "string",
  • "members": [
    ],
  • "members_object": [
    ],
  • "groups": [
    ],
  • "groups_object": [
    ],
  • "access_policies": [
    ],
  • "access_policies_object": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z"
}

Api V1 Iam Role Delete

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this role.

Responses

api

api_v1_iam_resource-group-assignment_list

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_iam_resource-group-assignment_create

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
id
integer (Id)
resource_group
required
integer (Resource group)
content_type
required
integer (Content type)
object_id
required
integer (Object id) [ 0 .. 2147483647 ]
object_user_code
string or null (User code) <= 1024 characters

Unique Code for referenced object.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

api_v1_iam_resource-group-assignment_read

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group assignment.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

api_v1_iam_resource-group-assignment_update

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group assignment.

Request Body schema: application/json
required
id
integer (Id)
resource_group
required
integer (Resource group)
content_type
required
integer (Content type)
object_id
required
integer (Object id) [ 0 .. 2147483647 ]
object_user_code
string or null (User code) <= 1024 characters

Unique Code for referenced object.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

api_v1_iam_resource-group-assignment_partial_update

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group assignment.

Request Body schema: application/json
required
id
integer (Id)
resource_group
required
integer (Resource group)
content_type
required
integer (Content type)
object_id
required
integer (Object id) [ 0 .. 2147483647 ]
object_user_code
string or null (User code) <= 1024 characters

Unique Code for referenced object.

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "resource_group": 0,
  • "content_type": 0,
  • "object_id": 2147483647,
  • "object_user_code": "string"
}

api_v1_iam_resource-group-assignment_delete

A viewset for viewing and editing ResourceGroupAssignment instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group assignment.

Responses

api_v1_iam_resource-group_list

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
query Parameters
page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "next": "http://example.com",
  • "previous": "http://example.com",
  • "results": [
    ]
}

api_v1_iam_resource-group_create

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
Request Body schema: application/json
required
user_code
string or null (User Code) <= 1024 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string or null (Description)
Array of objects (ResourceGroupAssignment)
members
Array of integers unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "members": [
    ],
  • "members_object": [
    ]
}

api_v1_iam_resource-group_read

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group.

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "members": [
    ],
  • "members_object": [
    ]
}

api_v1_iam_resource-group_update

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group.

Request Body schema: application/json
required
user_code
string or null (User Code) <= 1024 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string or null (Description)
Array of objects (ResourceGroupAssignment)
members
Array of integers unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "members": [
    ],
  • "members_object": [
    ]
}

api_v1_iam_resource-group_partial_update

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group.

Request Body schema: application/json
required
user_code
string or null (User Code) <= 1024 characters
configuration_code
required
string (Configuration Code) [ 1 .. 255 ] characters
name
required
string (Name) [ 1 .. 255 ] characters
description
string or null (Description)
Array of objects (ResourceGroupAssignment)
members
Array of integers unique

Responses

Request samples

Content type
application/json
{
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "members": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "user_code": "string",
  • "configuration_code": "string",
  • "name": "string",
  • "description": "string",
  • "assignments": [
    ],
  • "created_at": "2019-08-24T14:15:22Z",
  • "modified_at": "2019-08-24T14:15:22Z",
  • "members": [
    ],
  • "members_object": [
    ]
}

api_v1_iam_resource-group_delete

A viewset for viewing and editing ResourceGroup instances.

Authorizations:
BearerSingleSignOn
path Parameters
realm_code
required
string
space_code
required
string
id
required
integer

A unique integer value identifying this resource group.

Responses