1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
use http::StatusCode;
use super::OrgHandler;
use crate::models::orgs::secrets::{CreateOrganizationSecret, CreateOrganizationSecretResponse};
/// A client to GitHub's organization API.
///
/// Created with [`crate::Octocrab::orgs`].
pub struct OrgSecretsHandler<'octo> {
org: &'octo OrgHandler<'octo>,
}
impl<'octo> OrgSecretsHandler<'octo> {
pub(crate) fn new(org: &'octo OrgHandler<'octo>) -> Self {
Self { org }
}
fn owner(&self) -> &String {
&self.org.owner
}
/// Lists all secrets available in an organization without revealing their encrypted values.
/// You must authenticate using an access token with the admin:org scope to use this endpoint.
/// GitHub Apps must have the secrets organization permission to use this endpoint.
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let org = octocrab.orgs("owner");
/// let secrets = org.secrets();
/// let all_secrets = secrets.get_secrets().await?;
/// # Ok(())
/// # }
pub async fn get_secrets(
&self,
) -> crate::Result<crate::models::orgs::secrets::OrganizationSecrets> {
let route = format!("/orgs/{org}/actions/secrets", org = self.owner());
self.org.crab.get(route, None::<&()>).await
}
// Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets.
// You must authenticate using an access token with the admin:org scope to use this endpoint.
// GitHub Apps must have the secrets organization permission to use this endpoint.
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let org = octocrab.orgs("owner");
/// let secrets = org.secrets();
/// let public_key = secrets.get_public_key().await?;
/// # Ok(())
/// # }
pub async fn get_public_key(&self) -> crate::Result<crate::models::PublicKey> {
let route = format!("/orgs/{org}/actions/secrets/public-key", org = self.owner());
self.org.crab.get(route, None::<&()>).await
}
/// Gets a specific secret from the organization without revealing its encrypted values.
/// You must authenticate using an access token with the admin:org scope to use this endpoint.
/// GitHub Apps must have the secrets organization permission to use this endpoint.
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let org = octocrab.orgs("owner");
/// let secrets = org.secrets();
/// let secret_info = secrets.get_secret("TOKEN").await?;
/// # Ok(())
/// # }
pub async fn get_secret(
&self,
secret_name: impl AsRef<str>,
) -> crate::Result<crate::models::orgs::secrets::OrganizationSecret> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}",
org = self.owner(),
secret_name = secret_name.as_ref()
);
self.org.crab.get(route, None::<&()>).await
}
/// Creates or updates an organization secret with an encrypted value.
/// Encrypt your secret using [`crypto_box`](https://crates.io/crates/crypto_box).
/// You must authenticate using an access token with the admin:org scope to use this endpoint.
/// GitHub Apps must have the secrets organization permission to use this endpoint
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// use octocrab::models::orgs::secrets::{
/// CreateOrganizationSecret, CreateOrganizationSecretResponse,
/// Visibility
/// };
///
/// let org = octocrab.orgs("owner");
/// let secrets = org.secrets();
/// let result = secrets.create_or_update_secret("GH_TOKEN", &CreateOrganizationSecret{
/// key_id: "123456",
/// encrypted_value: "some-b64-encrypted-string",
/// visibility: Visibility::Selected,
/// selected_repository_ids: None,
/// }).await?;
///
/// match result {
/// CreateOrganizationSecretResponse::Created => println!("Created secret!"),
/// CreateOrganizationSecretResponse::Updated => println!("Updated secret!"),
/// }
/// # Ok(())
/// # }
pub async fn create_or_update_secret(
&self,
secret_name: impl AsRef<str>,
secret: &CreateOrganizationSecret<'_>,
) -> crate::Result<crate::models::orgs::secrets::CreateOrganizationSecretResponse> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}",
org = self.owner(),
secret_name = secret_name.as_ref()
);
let resp = {
let resp = self.org.crab._put(route, Some(secret)).await?;
crate::map_github_error(resp).await?
};
match resp.status() {
StatusCode::CREATED => Ok(CreateOrganizationSecretResponse::Created),
StatusCode::NO_CONTENT => Ok(CreateOrganizationSecretResponse::Updated),
status_code => Err(crate::Error::Other {
source: format!(
"Unexpected status code from request: {}",
status_code.as_str()
)
.into(),
backtrace: snafu::Backtrace::capture(),
}),
}
}
/// Deletes an organization secret.
/// You must authenticate using an access token with the admin:org scope to use this endpoint.
/// GitHub Apps must have the secrets organization permission to use this endpoint
/// ```no_run
/// # async fn run(octocrab: &octocrab::Octocrab) -> octocrab::Result<()> {
/// let org = octocrab.orgs("owner");
/// let secrets = org.secrets();
///
/// secrets.delete_secret("GH_TOKEN").await?;
///
/// # Ok(())
/// # }
pub async fn delete_secret(&self, secret_name: impl AsRef<str>) -> crate::Result<()> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}",
org = self.owner(),
secret_name = secret_name.as_ref()
);
let resp = self.org.crab._delete(route, None::<&()>).await?;
crate::map_github_error(resp).await?;
Ok(())
}
/// Lists selected repositories that have access to an organization secret.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#list-selected-repositories-for-an-organization-secret)
pub async fn list_selected_repositories(
&self,
secret_name: impl AsRef<str>,
) -> crate::Result<crate::models::actions::ActionsSelectedRepositories> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}/repositories",
org = self.owner(),
secret_name = secret_name.as_ref(),
);
self.org.crab.get(route, None::<&()>).await
}
/// Sets selected repositories that have access to an organization secret.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#set-selected-repositories-for-an-organization-secret)
pub async fn set_selected_repositories(
&self,
secret_name: impl AsRef<str>,
selected_repository_ids: &[crate::models::RepositoryId],
) -> crate::Result<()> {
#[derive(serde::Serialize)]
struct Body<'a> {
selected_repository_ids: &'a [crate::models::RepositoryId],
}
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}/repositories",
org = self.owner(),
secret_name = secret_name.as_ref(),
);
let body = Body {
selected_repository_ids,
};
crate::map_github_error(self.org.crab._put(route, Some(&body)).await?)
.await
.map(drop)
}
/// Adds a selected repository to an organization secret.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#add-selected-repository-to-an-organization-secret)
pub async fn add_selected_repository(
&self,
secret_name: impl AsRef<str>,
repository_id: crate::models::RepositoryId,
) -> crate::Result<()> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
org = self.owner(),
secret_name = secret_name.as_ref(),
);
crate::map_github_error(self.org.crab._put(route, None::<&()>).await?)
.await
.map(drop)
}
/// Removes a selected repository from an organization secret.
///
/// See: [GitHub API Documentation](https://docs.github.com/en/rest/actions/secrets?apiVersion=2022-11-28#remove-selected-repository-from-an-organization-secret)
pub async fn remove_selected_repository(
&self,
secret_name: impl AsRef<str>,
repository_id: crate::models::RepositoryId,
) -> crate::Result<()> {
let route = format!(
"/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}",
org = self.owner(),
secret_name = secret_name.as_ref(),
);
crate::map_github_error(self.org.crab._delete(route, None::<&()>).await?)
.await
.map(drop)
}
}