Add My Organisation Member
POST /obp/v7.0.0/my/organisations/ORGANISATION_ID/members
OBPv7.0.0-addMyOrganisationMember No role required Organisation
Add a User to one of your Organisations, as admin or member. Only its admins may. The new member can read their user_id from Get Current User.
An Organisation is a company or team that uses the APIs, for example a fintech, and owns Consumers. Its members are admins or members. Members may act for the Organisation's Consumers without a Role: read them, their usage, Scopes and API Product Subscriptions, and subscribe them. Admins also change the Organisation and its members, and move Consumers into or out of it.
Its bank_id is the space that administers it, and staff Roles for Organisations are held there. An Organisation you create for yourself is at SYS. Only staff with CanCreateOrganisationAtOneBank at a bank create one there. The bank_id is not a legal relationship with that bank, which is what a Customer is. An Organisation is not a Tenant either: a Tenant is a customer of the operator of this instance.
Authentication is Required.
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
URL Parameters:
ORGANISATION_ID: 8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0
JSON request body fields (2)
- member_role
- member_role
- user_id
- 9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1
JSON response body fields (7)
Example request body
{
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"member_role": "member"
}Example success response
{
"organisation_id": "8ca8a7e4-6d02-48e3-a029-0b2bf89de9f0",
"user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"username": "susan.uk.29@example.com",
"provider": "https://oidc.example.com",
"member_role": "member",
"created_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"created_at": "1100-01-01T00:00:00Z"
}Possible errors (9)
- OBP-20001: User not logged in. Authentication is required!
- OBP-10001: Incorrect json format.
- OBP-30630: Organisation not found. Please specify the ORGANISATION_ID of an Organisation you belong to.
- OBP-30631: Only an admin of the Organisation can do this.
- OBP-30632: Invalid member_role. Allowed values are: admin, member.
- OBP-20005: User not found. Please specify a valid value for USER_ID.
- OBP-30633: The User is already a member of this Organisation.
- OBP-30642: Could not change the members of the Organisation.
- OBP-50000: Unknown Error.