slackline - v1.0.0

slackline/api/admin/barriers

This module is generated by gleam run -m slackline_codegen/generate. Do not edit it by hand.

Admin barriers: information barriers between IDP groups.

Types

Barrier

</>

An information barrier.

pub type Barrier {
  Barrier(
    id: String,
    enterprise_id: option.Option(String),
    primary_usergroup: option.Option(BarrierUsergroup),
    barriered_from_usergroups: option.Option(
      List(BarrierUsergroup),
    ),
    restricted_subjects: option.Option(List(String)),
    date_update: option.Option(Int),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

BarrierUsergroup

</>

An IDP group referenced by an information barrier.

pub type BarrierUsergroup {
  BarrierUsergroup(id: String, name: option.Option(String))
}

Constructors

Create

</>

Identifies admin.barriers.create in the slackline.Call that create returns.

pub type Create

CreateResponse

</>

A successful response from admin.barriers.create.

pub type CreateResponse {
  CreateResponse(barrier: option.Option(Barrier))
}

Constructors

Delete

</>

Identifies admin.barriers.delete in the slackline.Call that delete returns.

pub type Delete

ListMethod

</>

Identifies admin.barriers.list in the slackline.Call that list returns.

pub type ListMethod

ListResponse

</>

A successful response from admin.barriers.list.

pub type ListResponse {
  ListResponse(
    barriers: option.Option(List(Barrier)),
    response_metadata: option.Option(slackline.ResponseMetadata),
  )
}

Constructors

Update

</>

Identifies admin.barriers.update in the slackline.Call that update returns.

pub type Update

UpdateResponse

</>

A successful response from admin.barriers.update.

pub type UpdateResponse {
  UpdateResponse(barrier: option.Option(Barrier))
}

Constructors

Values

barrier_decoder

</> 
pub fn barrier_decoder() -> decode.Decoder(Barrier)

Decodes Barrier from json.

barrier_to_json

</> 
pub fn barrier_to_json(it: Barrier) -> json.Json

Encodes Barrier as json.

barrier_usergroup_decoder

</> 
pub fn barrier_usergroup_decoder() -> decode.Decoder(
  BarrierUsergroup,
)

Decodes BarrierUsergroup from json.

barrier_usergroup_to_json

</> 
pub fn barrier_usergroup_to_json(
  it: BarrierUsergroup,
) -> json.Json

Encodes BarrierUsergroup as json.

create

</> 
pub fn create(
  primary_usergroup_id primary_usergroup_id: String,
  barriered_from_usergroup_ids barriered_from_usergroup_ids: List(
    String,
  ),
  restricted_subjects restricted_subjects: List(String),
) -> slackline.Call(Create, CreateResponse)

admin.barriers.create: Create an Information Barrier

barriers.Create identifies this method in slackline.Call.

User token scopes: admin.barriers:write.

Rate limit tier: t2.

Documented errors: barrier_already_exists, barriered_from_usergroups_not_found, feature_not_enabled, invalid_restricted_subjects, not_an_admin, primary_usergroup_not_found.

create_response_decoder

</> 
pub fn create_response_decoder() -> decode.Decoder(CreateResponse)

Decodes the response from admin.barriers.create.

delete

</> 
pub fn delete(
  barrier_id barrier_id: String,
) -> slackline.Call(Delete, Nil)

admin.barriers.delete: Delete an existing Information Barrier

barriers.Delete identifies this method in slackline.Call.

User token scopes: admin.barriers:write.

Rate limit tier: t2.

Documented errors: barrier_not_found, feature_not_enabled, not_an_admin.

list

</> 
pub fn list() -> slackline.Call(ListMethod, ListResponse)

admin.barriers.list: Get all Information Barriers for your organization

barriers.ListMethod identifies this method in slackline.Call.

Set optional arguments with the functions in slackline/api/admin/barriers/list.

User token scopes: admin.barriers:read.

Rate limit tier: t2.

Documented errors: feature_not_enabled, invalid_cursor, not_an_admin.

list_response_decoder

</> 
pub fn list_response_decoder() -> decode.Decoder(ListResponse)

Decodes the response from admin.barriers.list.

update

</> 
pub fn update(
  barrier_id barrier_id: String,
  primary_usergroup_id primary_usergroup_id: String,
  barriered_from_usergroup_ids barriered_from_usergroup_ids: List(
    String,
  ),
  restricted_subjects restricted_subjects: List(String),
) -> slackline.Call(Update, UpdateResponse)

admin.barriers.update: Update an existing Information Barrier

barriers.Update identifies this method in slackline.Call.

User token scopes: admin.barriers:write.

Rate limit tier: t2.

Documented errors: barrier_already_exists, barrier_not_found, barriered_from_usergroups_not_found, feature_not_enabled, invalid_restricted_subjects, not_an_admin, primary_usergroup_not_found.

update_response_decoder

</> 
pub fn update_response_decoder() -> decode.Decoder(UpdateResponse)

Decodes the response from admin.barriers.update.

✨ Search Document