Skip to content
  • Auto
  • Light
  • Dark
Get Started

Delete Remove Membership

Remove Entitlement Membership
client.Apps.Entitlements.DeleteRemoveMembership(ctx, appEntitlementID, params) (*RevokeTaskIDstringAppEntitlementDeleteRemoveMembershipResponse, error)
delete/api/v1/apps/{app_id}/entitlements/{app_entitlement_id}/remove-membership

Invokes the c1.api.app.v1.AppEntitlements.RemoveEntitlementMembership method.

Parameters
appEntitlementIDstring

The appEntitlementId field.

paramsAppIDfieldAppUserIDfieldAppEntitlementDeleteRemoveMembershipParams
Hide ParametersShow Parameters
AppIDfield
param.Field[string]

Path param: The appId field.

AppUserIDfield
optional
param.Field[string]

Body param: The appUserId field.

Returns
AppEntitlementDeleteRemoveMembershipResponsestruct

The RemoveEntitlementMembershipResponse message.

Hide ParametersShow Parameters
RevokeTaskIDstring
optional

The ID of the revoke task created to remove the user from the entitlement, if the entitlement is an access profile (aka. catalog). It's aka. the JML task.

Request example Go
package main

import (
  "context"
  "fmt"

  "github.com/stainless-sdks/-go"
  "github.com/stainless-sdks/-go/option"
)

func main() {
  client := conductoronesdk.NewClient(
    option.WithAPIKey("My API Key"),
  )
  response, err := client.Apps.Entitlements.DeleteRemoveMembership(
    context.TODO(),
    "app_entitlement_id",
    conductoronesdk.AppEntitlementDeleteRemoveMembershipParams{
      AppID: "app_id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.RevokeTaskID)
}
200 Example
{
  "revokeTaskId": "revokeTaskId"
}