The Shipa Developer Hub

Welcome to the Shipa developer hub. You'll find comprehensive guides and documentation to help you start working with Shipa as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    Changelog

Team and User Management

The Shipa provider for Crossplane allows you to manage both teams and user provisioning on Shipa.

Creating Teams

apiVersion: shipa.crossplane.io/v1alpha1
kind: Team
metadata:
  name: cross-team
spec:
  forProvider:
    name: cross-team
    tags: ["dev", "test", "sandbox"]

Top-Level Attributes

Component

Type

Description

apiVersion

string

the version of the API.

kind

string

the kind of custom resource that will be created by Shipa.

Team is the kind used by Shipa for managing resource plans.

metadata

the name of the custom resource that will be created by Shipa.

spec

the specification that will be used by Shipa when creating the team.

Metadata

Component

Type

Description

name

string

the name of the custom resource that will be created by Shipa.

Specification

Component

Type

Description

name

string

the name of the team Shipa will create.

Required: Yes

tags

string

tags that should be assigned to the team when created.

Required: No

Creating Users

apiVersion: shipa.crossplane.io/v1alpha1
kind: User
metadata:
  name: shipa-user
spec:
  forProvider:
    email: [email protected]
    password: crossplaneUserPass

Top-Level Attributes

Component

Type

Description

apiVersion

string

the version of the API.

kind

string

the kind of custom resource that will be created by Shipa.

User is the kind used by Shipa for managing resource plans.

metadata

the name of the custom resource that will be created by Shipa.

spec

the specification that will be used by Shipa when creating the user.

Metadata

Component

Type

Description

name

string

the name of the custom resource that will be created by Shipa.

Specification

Component

Type

Description

email

string

the email of the user that will be added to Shipa.

Required: Yes

password

string

The password for the user. This will be the user's password credential.

the password should be at least 7 characters

Required: Yes

Updated 4 months ago


Team and User Management


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.