(0.0.1)

Download OpenAPI specification:Download

OAuth

Obtain an API access token.

The token endpoint is used by the client to obtain an access token by presenting an authorization grant.

SecurityNone
Request
Request Body schema:
required
grant_type
required
string

This is a constant value of client_credentials.

client_id
required
string

The client identifier issued to you by Identitii during API onboarding.

client_secret
required
string

The client secret issued to you by Identitii during API onboarding.

Responses
200

OK

default

Default error response

post/v1alpha/oauth2/token
Request samples
{
  • "grant_type": "client_credentials",
  • "client_id": "my-client-id",
  • "client_secret": "my-client-secret"
}
Response samples
application/json
{
  • "access_token": "my-access-token",
  • "token_type": "Bearer",
  • "expires_in": 3600
}

Organizations

List organizations

Lists organizations. The order is unspecified but deterministic. Newly created organizations will not necessarily be added to the end of the list.

SecurityOAuth
Request
query Parameters
page_size
integer <int32>

The maximum number of organizations to return. The service may return fewer than this value. If unspecified, at most 50 organizations will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token
string

A page token, received from a previous ListOrganizations call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListOrganizations must match the call that provided the page token.

Responses
200

OK

default

Default error response

get/v1alpha/organizations
Request samples 
Response samples 
application/json
{
  • "organizations": [
    ],
  • "next_page_token": "string"
}
Get organization
Gets an organization. Returns NOT_FOUND if the organization does not
 exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/organizations/{organization}
Request samples 
Response samples 
application/json
{
  • "name": "organizations/identitii",
  • "display_name": "Identitii"
}
Update organization
Updates an organization. Returns INVALID_ARGUMENT if the name of the
 organization is non-empty and does not equal the existing name.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
query Parameters
update_mask
string <field-mask> 
The list of fields to update.


 
Request Body schema: application/json
required
name
string
The resource name of this organization.
 The name is ignored when creating an organization.
 Format: organizations/{organization}


 
display_name
required
string
A human-readable name for this organization.


 
Responses 
200
OK


default
Default error response


patch/v1alpha/organizations/{organization}
Request samples 
application/json
{
  • "name": "organizations/identitii",
  • "display_name": "Identitii"
}
Response samples 
application/json
{
  • "name": "organizations/identitii",
  • "display_name": "Identitii"
}
List teams
Lists teams in an organization. The order is unspecified but
 deterministic. Newly created teams will not necessarily be added to the
 end of the list. Returns NOT_FOUND if the organization does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
query Parameters
page_size
integer <int32> 
The maximum number of teams to return. The service may return fewer than
 this value. If unspecified, at most 50 teams will be returned. The maximum
 value is 1000; values above 1000 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListTeams call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to ListTeams must match
 the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/organizations/{organization}/teams
Request samples 
Response samples 
application/json
{
  • "teams": [
    ],
  • "next_page_token": "string"
}
Create team
Creates a team, and returns the new team.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
query Parameters
team_id
string
The ID to use for the team, which will become the final component of the
 team's resource name.


 
Request Body schema: application/json
required
name
string
The resource name of this team.
 The name is ignored when creating a team.
 Format: organizations/{organization}/teams/{team}


 
display_name
required
string
A human-readable name for this team.


 
Responses 
200
OK


default
Default error response


post/v1alpha/organizations/{organization}/teams
Request samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Get team
Gets a team. Returns NOT_FOUND if the team does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/organizations/{organization}/teams/{team}
Request samples 
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Delete team
Deletes a team. Returns NOT_FOUND if the team does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
Responses 
200
OK


default
Default error response


delete/v1alpha/organizations/{organization}/teams/{team}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}
Update team
Updates a team. Returns INVALID_ARGUMENT if the name of the team is non-empty and does not equal the existing name.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
query Parameters
update_mask
string <field-mask> 
The list of fields to update.


 
Request Body schema: application/json
required
name
string
The resource name of this team.
 The name is ignored when creating a team.
 Format: organizations/{organization}/teams/{team}


 
display_name
required
string
A human-readable name for this team.


 
Responses 
200
OK


default
Default error response


patch/v1alpha/organizations/{organization}/teams/{team}
Request samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
RFIs
List RFIs
Lists RFIs. The order is unspecified but deterministic. Newly created RFIs
 will not necessarily be added to the end of the list.


SecurityOAuth 
Request 
query Parameters
page_size
integer <int32> 
The maximum number of RFIs to return. The service may return fewer than
 this value. If unspecified, at most 50 RFIs will be returned. The maximum
 value is 1000; values above 1000 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListRFIs call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to ListRFIs must match
 the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/rfis
Request samples 
Response samples 
application/json
{
  • "rfis": [
    ],
  • "next_page_token": "string"
}
Create RFI
Creates an RFI, and returns the new RFI.


SecurityOAuth 
Request 
query Parameters
rfi_id
string
The ID to use for the RFI, which will become the final component of the RFI's resource name.


 
Request Body schema: application/json
required
name
string
The resource name of this RFI.
 The name is ignored when creating an RFI.
 Format: rfis/{rfi}


 
required
object
The party that created this RFI.
 The creator cannot be changed after the RFI reaches OPEN status.


 
required
object
The party responsible for brokering this RFI.
 The broker cannot be changed after the RFI reaches OPEN status.


 
required
object
Initial data provided when the RFI was created.
 Input cannot be changed after the RFI reaches OPEN status.


 
Responses 
200
OK


default
Default error response


post/v1alpha/rfis
Request samples 
application/json
{
  • "name": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "input": {
    }
}
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Get RFI
Gets an RFI. Returns NOT_FOUND if the RFI does not exist.


SecurityOAuth 
Request 
path Parameters
rfi
required
string
The rfi id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/rfis/{rfi}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Update an RFI
Updates an RFI. Returns INVALID_ARGUMENT if the name of the RFI is non-empty and does not equal the existing name.


SecurityOAuth 
Request 
path Parameters
rfi
required
string
The rfi id.


 
query Parameters
update_mask
string <field-mask> 
The list of fields to update.


 
Request Body schema: application/json
required
name
string
The resource name of this RFI.
 The name is ignored when creating an RFI.
 Format: rfis/{rfi}


 
required
object
The party that created this RFI.
 The creator cannot be changed after the RFI reaches OPEN status.


 
required
object
The party responsible for brokering this RFI.
 The broker cannot be changed after the RFI reaches OPEN status.


 
required
object
Initial data provided when the RFI was created.
 Input cannot be changed after the RFI reaches OPEN status.


 
Responses 
200
OK


default
Default error response


patch/v1alpha/rfis/{rfi}
Request samples 
application/json
{
  • "name": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "input": {
    }
}
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Reject an RFI
Rejects an RFI. This functionality can used by the current assignee of an RFI
 to indicate that they cannot provide a response to this RFI.


SecurityOAuth 
Request 
path Parameters
rfi
required
string
The rfi id.


 
Request Body schema: application/json
required
name
required
string
The name of the RFI to reject.
 Format: rfis/{rfi}


 
comment
string
Optional comment explaining why the RFI was rejected.


 
Responses 
200
OK


default
Default error response


post/v1alpha/rfis/{rfi}:reject
Request samples 
application/json
{
  • "name": "string",
  • "comment": "string"
}
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Respond to an RFI
Responds to an RFI.


SecurityOAuth 
Request 
path Parameters
rfi
required
string
The rfi id.


 
Request Body schema: application/json
required
name
required
string
The name of the RFI to respond to.
 Format: rfis/{rfi}


 
required
object
TODO


 
Responses 
200
OK


default
Default error response


post/v1alpha/rfis/{rfi}:respond
Request samples 
application/json
{
  • "name": "string",
  • "responses": {
    }
}
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Revoke an RFI
Revokes an RFI. This functionality can used by the broker of an RFI to
 indicate that a response to this RFI is no longer required.


SecurityOAuth 
Request 
path Parameters
rfi
required
string
The rfi id.


 
Request Body schema: application/json
required
name
required
string
The name of the RFI to revoke.
 Format: rfis/{rfi}


 
comment
string
Optional comment explaining why the RFI was revoked.


 
Responses 
200
OK


default
Default error response


post/v1alpha/rfis/{rfi}:revoke
Request samples 
application/json
{
  • "name": "string",
  • "comment": "string"
}
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "creator": {
    },
  • "broker": {
    },
  • "current_assignee": {
    },
  • "initial_assignee": {
    },
  • "input": {
    },
  • "create_time": "2019-08-24T14:15:22Z",
  • "update_time": "2019-08-24T14:15:22Z",
  • "expire_time": "2019-08-24T14:15:22Z",
  • "status": "STATUS_UNSPECIFIED",
  • "fields": {
    },
  • "display_metadata": {
    }
}
Sharing
List data sharing agreements
Lists data sharing agreements. The order is unspecified but deterministic. Newly created agreements will
 not necessarily be added to the end of the list.


SecurityOAuth 
Request 
query Parameters
page_size
integer <int32> 
The maximum number of data sharing agreements to return. The service may
 return fewer than this value. If unspecified, at most 50 data sharing
 agreements will be returned. The maximum value is 1000; values above 1000
 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListDataSharingAgreements call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to
 ListDataSharingAgreements must match the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/dataSharingAgreements
Request samples 
Response samples 
application/json
{
  • "data_sharing_agreements": [
    ],
  • "next_page_token": "string"
}
Create data sharing agreement
Creates a data sharing agreement, and returns the new agreement.


SecurityOAuth 
Request 
query Parameters
data_sharing_agreement_id
string
The ID to use for the data sharing agreement, which will become the final
 component of the data sharing agreement's resource name.


 
Request Body schema: application/json
required
name
string
The resource name of this data sharing agreement.
 The name is ignored when creating an agreement.
 Format: dataSharingAgreements/{agreement}


 
display_name
required
string
A human-readable name for this data sharing agreement.


 
required
object
The party that determines the purposes and means of processing personal data.


 
required
object
The party that processes personal data on behalf of the controller.


 
Responses 
200
OK


default
Default error response


post/v1alpha/dataSharingAgreements
Request samples 
application/json
{
  • "name": "dataSharingAgreements/test-agreement",
  • "uid": "1c2568b0-d648-4b15-9fd4-1761f2442dbd",
  • "display_name": "Test Agreement",
  • "controller": {
    },
  • "processor": {
    }
}
Response samples 
application/json
{
  • "name": "dataSharingAgreements/test-agreement",
  • "uid": "1c2568b0-d648-4b15-9fd4-1761f2442dbd",
  • "display_name": "Test Agreement",
  • "controller": {
    },
  • "processor": {
    }
}
Get data sharing agreement
Gets a data sharing agreement. Returns NOT_FOUND if the agreement does not exist.


SecurityOAuth 
Request 
path Parameters
dataSharingAgreement
required
string
The dataSharingAgreement id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/dataSharingAgreements/{dataSharingAgreement}
Request samples 
Response samples 
application/json
{
  • "name": "dataSharingAgreements/test-agreement",
  • "uid": "1c2568b0-d648-4b15-9fd4-1761f2442dbd",
  • "display_name": "Test Agreement",
  • "controller": {
    },
  • "processor": {
    }
}
Delete data sharing agreement
Deletes a data sharing agreement. Returns NOT_FOUND if the agreement does not exist.


SecurityOAuth 
Request 
path Parameters
dataSharingAgreement
required
string
The dataSharingAgreement id.


 
Responses 
200
OK


default
Default error response


delete/v1alpha/dataSharingAgreements/{dataSharingAgreement}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}
Update data sharing agreement
Updates a data sharing agreement. Returns INVALID_ARGUMENT if the name of the agreement is
 non-empty and does not equal the existing name.


SecurityOAuth 
Request 
path Parameters
dataSharingAgreement
required
string
The dataSharingAgreement id.


 
query Parameters
update_mask
string <field-mask> 
The list of fields to update.


 
Request Body schema: application/json
required
name
string
The resource name of this data sharing agreement.
 The name is ignored when creating an agreement.
 Format: dataSharingAgreements/{agreement}


 
display_name
required
string
A human-readable name for this data sharing agreement.


 
required
object
The party that determines the purposes and means of processing personal data.


 
required
object
The party that processes personal data on behalf of the controller.


 
Responses 
200
OK


default
Default error response


patch/v1alpha/dataSharingAgreements/{dataSharingAgreement}
Request samples 
application/json
{
  • "name": "dataSharingAgreements/test-agreement",
  • "uid": "1c2568b0-d648-4b15-9fd4-1761f2442dbd",
  • "display_name": "Test Agreement",
  • "controller": {
    },
  • "processor": {
    }
}
Response samples 
application/json
{
  • "name": "dataSharingAgreements/test-agreement",
  • "uid": "1c2568b0-d648-4b15-9fd4-1761f2442dbd",
  • "display_name": "Test Agreement",
  • "controller": {
    },
  • "processor": {
    }
}
Workflows
List workflows
Lists workflows. The order is unspecified but deterministic.
 Newly created workflows will not necessarily be added to the end of the list.


SecurityOAuth 
Request 
query Parameters
page_size
integer <int32> 
The maximum number of workflows to return. The service may return fewer
 than this value. If unspecified, at most 50 workflows will be returned.
 The maximum value is 1000; values above 1000 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListWorkflows call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to ListWorkflows must
 match the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/workflows
Request samples 
Response samples 
application/json
{
  • "workflows": [
    ],
  • "next_page_token": "string"
}
Get workflow
Gets a workflow. Returns NOT_FOUND if the workflow does not exist.


SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/workflows/{workflow}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "display_name": "string"
}
List workflow executions
SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
query Parameters
page_size
integer <int32> 
The maximum number of workflow executions to return. The service may
 return fewer than this value. If unspecified, at most 50 workflow
 workflow executions will be returned. The maximum value is 1000; values above 1000
 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListWorkflowExecutions call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to ListWorkflowExecutions
 must match the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/workflows/{workflow}/executions
Request samples 
Response samples 
application/json
{
  • "workflow_executions": [
    ],
  • "next_page_token": "string"
}
Create workflow execution
Creates a workflow execution, and returns the new workflow execution.


SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
query Parameters
workflow_execution_id
string
The ID to use for the workflow execution, which will become the final
 component of the workflow execution's resource name.


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


 
request_id
string
A unique identifier for this request. Restricted to 36 ASCII characters.
 A random UUID is recommended.
 This request is only idempotent if a request_id is provided.


 
Request Body schema: application/json
required
name
string
The resource name of the execution.
 Format: workflows/{workflow}/executions/{execution}


 
object
Serialized argument to the workflow execution.


 
Responses 
200
OK


default
Default error response


post/v1alpha/workflows/{workflow}/executions
Request samples 
application/json
{
  • "name": "string",
  • "input": {
    }
}
Response samples 
application/json
{
  • "name": "string",
  • "metadata": {
    },
  • "done": true,
  • "error": {
    },
  • "response": {
    }
}
Get workflow execution
Gets a workflow execution. Returns NOT_FOUND if the workflow execution does not exist.


SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
execution
required
string
The execution id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/workflows/{workflow}/executions/{execution}
Request samples 
Response samples 
application/json
{
  • "name": "string",
  • "uid": "string",
  • "input": {
    }
}
Query workflow execution
Queries a workflow execution.


SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
execution
required
string
The execution id.


 
Request Body schema: application/json
required
name
required
string
 
required
object (bndry.api.workflows.v1alpha.Query) 
A query is a synchronous operation that is used to get the state of am
 WorkflowExecution.


 
Responses 
200
OK


default
Default error response


post/v1alpha/workflows/{workflow}/executions/{execution}:query
Request samples 
application/json
{
  • "name": "string",
  • "query": {
    }
}
Response samples 
application/json
{
  • "result": {
    }
}
Signal workflow execution
Signals a running workflow execution.


SecurityOAuth 
Request 
path Parameters
workflow
required
string
The workflow id.


 
execution
required
string
The execution id.


 
Request Body schema: application/json
required
name
required
string
 
required
object (bndry.api.workflows.v1alpha.Signal) 
A Signal is an asynchronous request to a WorkflowExecution.


 
request_id
string
A unique identifier for this request. Restricted to 36 ASCII characters.
 A random UUID is recommended.
 This request is only idempotent if a request_id is provided.


 
Responses 
200
OK


default
Default error response


post/v1alpha/workflows/{workflow}/executions/{execution}:signal
Request samples 
application/json
{
  • "name": "string",
  • "signal": {
    },
  • "request_id": "string"
}
Response samples 
application/json
{ }
Teams
List teams
Lists teams in an organization. The order is unspecified but
 deterministic. Newly created teams will not necessarily be added to the
 end of the list. Returns NOT_FOUND if the organization does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
query Parameters
page_size
integer <int32> 
The maximum number of teams to return. The service may return fewer than
 this value. If unspecified, at most 50 teams will be returned. The maximum
 value is 1000; values above 1000 will be coerced to 1000.


 
page_token
string
A page token, received from a previous ListTeams call.
 Provide this to retrieve the subsequent page.


 When paginating, all other parameters provided to ListTeams must match
 the call that provided the page token.


 
Responses 
200
OK


default
Default error response


get/v1alpha/organizations/{organization}/teams
Request samples 
Response samples 
application/json
{
  • "teams": [
    ],
  • "next_page_token": "string"
}
Create team
Creates a team, and returns the new team.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
query Parameters
team_id
string
The ID to use for the team, which will become the final component of the
 team's resource name.


 
Request Body schema: application/json
required
name
string
The resource name of this team.
 The name is ignored when creating a team.
 Format: organizations/{organization}/teams/{team}


 
display_name
required
string
A human-readable name for this team.


 
Responses 
200
OK


default
Default error response


post/v1alpha/organizations/{organization}/teams
Request samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Get team
Gets a team. Returns NOT_FOUND if the team does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
Responses 
200
OK


default
Default error response


get/v1alpha/organizations/{organization}/teams/{team}
Request samples 
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Delete team
Deletes a team. Returns NOT_FOUND if the team does not exist.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
Responses 
200
OK


default
Default error response


delete/v1alpha/organizations/{organization}/teams/{team}
Request samples 
Response samples 
application/json
{
  • "code": 0,
  • "message": "string",
  • "details": [
    ]
}
Update team
Updates a team. Returns INVALID_ARGUMENT if the name of the team is non-empty and does not equal the existing name.


SecurityOAuth 
Request 
path Parameters
organization
required
string
The organization id.


 
team
required
string
The team id.


 
query Parameters
update_mask
string <field-mask> 
The list of fields to update.


 
Request Body schema: application/json
required
name
string
The resource name of this team.
 The name is ignored when creating a team.
 Format: organizations/{organization}/teams/{team}


 
display_name
required
string
A human-readable name for this team.


 
Responses 
200
OK


default
Default error response


patch/v1alpha/organizations/{organization}/teams/{team}
Request samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}
Response samples 
application/json
{
  • "name": "organizations/test-org",
  • "uid": "735a71e4-d33d-4415-a243-e19dea52ed1f",
  • "display_name": "Test Organization"
}