SecurityAgent / Client / create_membership

create_membership¶

SecurityAgent.Client.create_membership(**kwargs)¶

Creates a new membership, granting a user access to an agent space within an application.

Request Syntax

response = client.create_membership(
    applicationId='string',
    agentSpaceId='string',
    membershipId='string',
    memberType='USER',
    config={
        'user': {
            'role': 'MEMBER'
        }
    }
)

Parameters:

applicationId (string) –
[REQUIRED]

The unique identifier of the application that contains the agent space.
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space to grant access to.
membershipId (string) –
[REQUIRED]

The unique identifier for the membership.
memberType (string) –
[REQUIRED]

The type of member. Currently, only USER is supported.
config (dict) –
The configuration for the membership, such as the user role.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: user.
- user (dict) –
  
  The user configuration for the membership.
  - role (string) –
    
    The role assigned to the user. Currently, only MEMBER is supported.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

(dict) –

Response structure for adding a single member to an agent space.