roles

package
v4.35.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 15, 2025 License: MIT Imports: 0 Imported by: 0

README

roles

Go Report Card

A Go package to make requests to the WorkOS Roles API.

Install

go get -u github.com/workos/workos-go/v4/pkg/roles

How it works

See the Roles API reference.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Role 

type Role struct {
	// The Role's unique identifier.
	ID string `json:"id"`

	Name string `json:"name"`

	// The Role's slug key for referencing it in code.
	Slug string `json:"slug"`

	Description string `json:"description"`

	// The type of role
	Type RoleType `json:"type"`

	// The timestamp of when the Role was created.
	CreatedAt string `json:"created_at"`

	// The timestamp of when the Role was updated.
	UpdatedAt string `json:"updated_at"`
}

Role contains data about a WorkOS Role.

type RoleType 

type RoleType string

RoleType represents the type of a Role. 

const (
	Environment  RoleType = "EnvironmentRole"
	Organization RoleType = "OrganizationRole"
)

Constants that enumerate the type of a Role.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.