API docs by Redocly

Membership portal (1.0.0)

Download OpenAPI specification:Download

Software Development Team: software-dev@eclipse-foundation.org URL: https://gitlab.eclipse.org/eclipsefdn/software-dev License: Eclipse Public License - 2.0

API used for reading and updating information about member organizations and it's associated metadata.

Organizations

Definitions related to Eclipse Foundation organizations

Organizations List

Returns a list of organizations from the Eclipse API

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Slim Organizations List

Returns a list of paired down organizations from the Eclipse API, returning just critical data

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization

Returns an organization that has a matching ID

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "name": "string",
  • "renewal_date": "string",
  • "member_since": "string",
  • "is_active_member": true,
  • "levels": [
    ],
  • "description": {
    },
  • "website": "string",
  • "logos": {
    },
  • "wgpas": [
    ]
}

Organization Info update

Updates an organization information and returns the updated entity

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Request Body schema: application/json
description
string

Description of the stored URL/product

company_url
string

URL for the product

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "company_url": "string"
}

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "name": "string",
  • "renewal_date": "string",
  • "member_since": "string",
  • "is_active_member": true,
  • "levels": [
    ],
  • "description": {
    },
  • "website": "string",
  • "logos": {
    },
  • "wgpas": [
    ]
}

Organization CBI

Returns the CBI information for the current organization

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
{
  • "memberOrganizationsBenefits": [
    ],
  • "sponsoredProjects": [
    ]
}

Organization logo update

Updates an organization logo and returns the updated entity

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Request Body schema: multipart/form-data
image
object

The image file. Should be included as a file would naturally be included in a form without encoding

image_mime
string

The mime type for the image

image_format
string
Enum: "SMALL" "LARGE" "PRINT"

the format of logo image to be updated

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "name": "string",
  • "renewal_date": "string",
  • "member_since": "string",
  • "is_active_member": true,
  • "levels": [
    ],
  • "description": {
    },
  • "website": "string",
  • "logos": {
    },
  • "wgpas": [
    ]
}

Organization Projects

Returns projects associated with the organization

path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the associated entities to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization Committers

Returns committers associated with the organization

Authorizations:
openId
path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the associated entities to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization Contributors

Returns contributors associated with the organization

Authorizations:
openId
path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the associated entities to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization Membership Transactions

Returns the membership billing transaction history for the organization, distinguishing standard membership dues from working group collaboration dues. Restricted to the organization's CR (Company Representative) contact, as billing information is sensitive.

Authorizations:
openId
path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the organization to retrieve transactions for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization working groups

Gets working groups the organization is member to

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization Contacts

Definitions related to Eclipse Foundation organization contacts

Organization

Returns a list of contacts for the given organization with additional data such as name and email

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization

Returns a list of contact relations for the given user in the passed organization

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

contactID
required
string

The contact ID/username of the contact to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Request Organization contact removal

Fires a request for a organization contact to be removed.

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

contactID
required
string

The contact ID/username of the contact to retrieve

Request Body schema: application/json

The working group to be updated or inserted into the data set.

organization_id
integer

the target organization to remove user from

username
string

the user that should be removed from the organization

reason
string

the reason the user should be removed from the organization

Responses

Request samples

Content type
application/json
{
  • "organization_id": 0,
  • "username": "string",
  • "reason": "string"
}

Organization

Returns a contact relations for the given user and relation/position in the passed organization if it exists

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

contactID
required
string

The contact ID/username of the contact to retrieve

relation
required
string

The relation code of the relation type to retrieve/check for/update.

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "person_id": "string",
  • "relation": "string",
  • "comments": "string",
  • "title": "string"
}

Organization

Updates an organization contact and returns the updated entity

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

contactID
required
string

The contact ID/username of the contact to retrieve

relation
required
string

The relation code of the relation type to retrieve/check for/update.

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "person_id": "string",
  • "relation": "string",
  • "comments": "string",
  • "title": "string"
}

Organization

Removes a single organization contact relation. Works for all relations except EMPLY and CR, which must be done manually through the membership team.

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

contactID
required
string

The contact ID/username of the contact to retrieve

relation
required
string

The relation code of the relation type to retrieve/check for/update.

Responses

Response samples

Content type
application/json
{
  • "status_code": 0,
  • "message": "string",
  • "url": "string"
}

Organization

Returns a list of contacts with elevated roles for the given organization with their name.

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "first_name": "string",
  • "last_name": "string",
  • "email": "string",
  • "relations": [
    ]
}

Organization Products

Definitions related to Eclipse Foundation organization products

Organization Products list

Returns a contact relations for the given user and relation/position in the passed organization if it exists

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organization Product create

Creates an organization product/link using the body

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Organization Product

Returns a organization product/link if it exists

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization product to retrieve

productID
required
number

The product ID for the organization product to retrieve

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "description": "string",
  • "product_url": "string"
}

Organization Product create

Updates an organization product/link using the body

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization product to retrieve

productID
required
number

The product ID for the organization product to retrieve

Responses

Response samples

Content type
application/json
{
  • "organization_id": 0,
  • "product_id": 0,
  • "name": "string",
  • "description": "string",
  • "product_url": "string"
}

Organization Product delete

Remove the organization product that matches the given path parameters

Authorizations:
openId
path Parameters
organizationID
required
number

The organization ID for the organization product to retrieve

productID
required
number

The product ID for the organization product to retrieve

Responses

Organization Activity

Definitions related to Eclipse Foundation organization committer/contributor activity

Organization Committers activity

Returns activity of an organizations commiters

Authorizations:
openId
path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the associated entities to retrieve

query Parameters
period
string

The period of activity

from_period
string

The starting period of activity

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "period": "string"
}

Organization Committers yearly activity

Returns yearly activity of an organizations commiters

Authorizations:
openId
path Parameters
organizationID
required
string or null (ObjectID) >= 1

The organization ID for the associated entities to retrieve

query Parameters
period
string

The period of activity

from_period
string

The starting period of activity

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "period": "string"
}

Organization Activity

Gets the organization activity for a given period

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

query Parameters
period
string

The period of activity

from_period
string

The starting period of activity

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "period": "string"
}

Organization Activity overview

Gets the organization activity overview for a given period

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

query Parameters
period
string

The period of activity

from_period
string

The starting period of activity

Responses

Response samples

Content type
application/json
{
  • "count": 0,
  • "period": "string"
}

Organization yearly activity

Gets the organization activity for a year

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve

Responses

Response samples

Content type
application/json
{
  • "activity": [
    ]
}

Working Groups

Definitions related to Eclipse Foundation working group entities

Organization Working Group representatives

Gets working group representatives grouped by the alias of the Working Group they are part of

path Parameters
organizationID
required
number

The organization ID for the organization to retrieve representatives for

Responses

Response samples

Content type
application/json
{
  • "property1": [
    ],
  • "property2": [
    ]
}

Working Group List Deprecated

Returns a working group entry that has a matching ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Working Group Deprecated

Returns a working group entry that has a matching ID

path Parameters
documentID
required
string or null (ObjectID) >= 1

The document ID for the working group to retrieve

Responses

Response samples

Content type
application/json
{
  • "alias": "string",
  • "title": "string",
  • "status": "string",
  • "logo": "string",
  • "description": "string",
  • "resources": {
    },
  • "levels": [
    ]
}

Projects

Definitions related to Eclipse Foundation projects entities in relation to organizations

Project Organizations

Returns a list of active and participating organizations from the Eclipse API for the given project

path Parameters
projectId
required
string

The project ID to retrieve active projects for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Slack Webhook

Slack Webhook processing

Industry Collaboration Organizations

Definitions related to collaborations with regard to organizations

Organizations for Interest Group

returns list of organizations with participants for the given Interest Group

path Parameters
id
required
number

ID of the interest group to retrieve associated organizations for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Organizations for Special Interest Group

returns list of organizations with participants for the given Special Interest Group

path Parameters
id
required
string

alias of the special interest group to retrieve associated organizations for

Responses

Response samples

Content type
application/json
[
  • {
    }
]

System relations

Definitions related to Eclipse Foundation relation code entities

List of relations by type

Returns a list of system relations by the given type

query Parameters
type
string

The type of relation

Responses

Response samples

Content type
application/json
[
  • {
    }
]

User Info

Internal user info endpoints for logged in user

Info on currently logged in user

Returns information about the currently logged in user

query Parameters
organization_id
integer

The id of the organization to impersonate.

role
string

The organizational role to impersonate.

Responses

Response samples

Content type
application/json
{
  • "name": "string",
  • "given_name": "string",
  • "family_name": "string",
  • "email": "string",
  • "organizational_roles": {
    }
}