(0.0.1)

Download OpenAPI description

openapi.json

openapi.yaml

Servers

Mock server

https://docs.bndry.net/_mock/apis/openapi/

https://api.{customer}.app.identitii.com/

AuthenticationService

Operations

DraftService

Operations

RFIService

Operations

ScenarioService

Operations

TeamService

Operations

List teams

Request

List teams.

Query

page_sizeinteger(int32)

Optional. The maximum number of teams to return. The service may return fewer than this value. If unspecified, the server will decide the number of teams to return.

page_tokenstring

Optional. A page token received from a previous ListTeams call. Provide this to retrieve the subsequent page of results.

show_deletedboolean

Optional. Controls whether deleted teams are included in the response. Defaults to false.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams?page_size=0&page_token=string&show_deleted=true' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

teamsArray of objects(Team)

The list of teams.

next_page_tokenstring

A token to retrieve the next page of results. This field is empty if there are no more results.

Response

application/json

{
  "teams": [
    { … }
  ],
  "next_page_token": "string"
}

Create a team

Request

Create a team.

Query

team_idstring

Optional. The ID to use for the team, which will become the final component of the team's resource name. A system-generated ID will be used if this is not provided.

This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.

Bodyapplication/jsonrequired

namestring

The resource name of the team.

Format: teams/{team}

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams?team_id=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "display_name": "string",
    "annotations": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Bodyapplication/json

namestring

The resource name of the team.

Format: teams/{team}

uidstringread-only

A system-assigned unique identifier for the team, in UUID4 format.

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

parent_teamstringread-only

The resource name of this team's parent.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

create_timestring(date-time)read-only

Timestamp of when the team was created.

update_timestring(date-time)read-only

Timestamp of when the team was last updated.

delete_timestring(date-time)read-only

Timestamp of when the team was deleted.

etagstringread-only

The etag of the team, used for optimistic concurrency control.

Response

application/json

{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "parent_team": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

Get a team

Request

Get a team.

Path

teamstringrequired

The team id.

curl -i -X GET \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams/{team}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Bodyapplication/json

namestring

The resource name of the team.

Format: teams/{team}

uidstringread-only

A system-assigned unique identifier for the team, in UUID4 format.

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

parent_teamstringread-only

The resource name of this team's parent.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

create_timestring(date-time)read-only

Timestamp of when the team was created.

update_timestring(date-time)read-only

Timestamp of when the team was last updated.

delete_timestring(date-time)read-only

Timestamp of when the team was deleted.

etagstringread-only

The etag of the team, used for optimistic concurrency control.

Response

application/json

{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "parent_team": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

Delete a team

Request

Delete a team.

Path

teamstringrequired

The team id.

Query

etagstring

Optional. The current ETag of the team.

If provided, and this value does not match the current ETag of the team, the request will fail and an ABORTED error will be returned.

curl -i -X DELETE \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams/{team}?etag=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Body

Response

application/json

{
  "code": 0,
  "message": "string",
  "details": [
    { … }
  ]
}

Update a team

Request

Update a team.

Path

teamstringrequired

The team id.

Query

update_maskstring(field-mask)

Optional. The fields to update.

Bodyapplication/jsonrequired

namestring

The resource name of the team.

Format: teams/{team}

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

curl -i -X PATCH \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams/{team}?update_mask=string' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "display_name": "string",
    "annotations": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Bodyapplication/json

namestring

The resource name of the team.

Format: teams/{team}

uidstringread-only

A system-assigned unique identifier for the team, in UUID4 format.

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

parent_teamstringread-only

The resource name of this team's parent.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

create_timestring(date-time)read-only

Timestamp of when the team was created.

update_timestring(date-time)read-only

Timestamp of when the team was last updated.

delete_timestring(date-time)read-only

Timestamp of when the team was deleted.

etagstringread-only

The etag of the team, used for optimistic concurrency control.

Response

application/json

{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "parent_team": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

Undelete a team

Request

Undelete a team.

Path

teamstringrequired

The team id.

Bodyapplication/jsonrequired

namestringrequired

Required. The resource name of the deleted team.

Format: teams/{team}

etagstring

Optional. The current ETag of the team.

If provided, and this value does not match the current ETag of the team, the request will fail and an ABORTED error will be returned.

curl -i -X POST \
  'https://docs.bndry.net/_mock/apis/openapi/request/v1alpha/teams/{team}:undelete' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string",
    "etag": "string"
  }'

Responses

Bodyapplication/json

namestring

The resource name of the team.

Format: teams/{team}

uidstringread-only

A system-assigned unique identifier for the team, in UUID4 format.

display_namestringrequired

A human-readable name for the team, for use in user interfaces.

parent_teamstringread-only

The resource name of this team's parent.

annotationsobject

Unstructured key-value pairs that can be used to store and retrieve arbitrary metadata related to the team.

Annotations are intended for client-side usage. They are not used by the server except for size or character set validation as defined in AIP-148

create_timestring(date-time)read-only

Timestamp of when the team was created.

update_timestring(date-time)read-only

Timestamp of when the team was last updated.

delete_timestring(date-time)read-only

Timestamp of when the team was deleted.

etagstringread-only

The etag of the team, used for optimistic concurrency control.

Response

application/json

{
  "name": "string",
  "uid": "string",
  "display_name": "string",
  "parent_team": "string",
  "annotations": {
    "property1": "string",
    "property2": "string"
  },
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "delete_time": "2019-08-24T14:15:22Z",
  "etag": "string"
}

(0.0.1)

AuthenticationService

DraftService

RFIService

ScenarioService

TeamService

List teams

Request

Responses

Was this helpful?

Create a team

Request

Responses

Was this helpful?

Get a team

Request

Responses

Was this helpful?

Delete a team

Request

Responses

Was this helpful?

Update a team

Request

Responses

Was this helpful?

Undelete a team

Request

Responses

Was this helpful?

(0.0.1)

AuthenticationService

DraftService

RFIService

ScenarioService

TeamService

List teams

Request

Responses

Was this helpful?

Create a team

RequestExpand all

Responses

Was this helpful?

Get a team

Request

Responses

Was this helpful?

Delete a team

Request

Responses

Was this helpful?

Update a team

RequestExpand all

Responses

Was this helpful?

Undelete a team

Request

Responses

Was this helpful?

Request

Request